Checks for enums that define writeObject() or writeReplace() methods, or declare serialPersistentFields or serialVersionUID fields, all of which are ignored for enums.
From the javadoc for ObjectOutputStream:
The process by which enum constants are serialized cannot be customized; any class-specific writeObject and writeReplace methods defined by enum types are ignored during serialization. Similarly, any serialPersistentFields or serialVersionUID field declarations are also ignored--all enum types have a fixed serialVersionUID of 0L.
Example of violations:
enum MyEnum {
ONE, TWO, THREE
private static final long serialVersionUID = 1234567L // violation
private static final ObjectStreamField[] serialPersistentFields = // violation
{ new ObjectStreamField("name", String.class) }
String name;
Object writeReplace() throws ObjectStreamException { .. } // violation
private void writeObject(ObjectOutputStream stream) { .. } // violation
}
To use a Serializable object's serialPersistentFields correctly, it must be declared private, static, and final.
The Java Object Serialization Specification allows developers to manually define Serializable fields for a class by specifying them in the serialPersistentFields array. This feature will only work if serialPersistentFields is declared as private, static, and final. Also, specific to Groovy, the field must be of type ObjectStreamField[], and cannot be Object.
References:
Standards Mapping - Common Weakness Enumeration - (CWE) CWE ID 485
Sun Microsystems, Inc. Java Sun Tutorial
Example of violations:
class MyClass implements Serializable {
public ObjectStreamField[] serialPersistentFields = [ new ObjectStreamField("myField", List.class) ] as ObjectStreamField[]
}
// the JVM sees the field type as Object, which won't work
class MyOtherClass implements Serializable {
private static final serialPersistentFields = [ new ObjectStreamField("myField", List.class) ] as ObjectStreamField[]
}
A serialVersionUID is normally intended to be used with Serialization. It needs to be of type long, static, and final. Also, it should be declared private. Providing no modifier creates a Property and Groovy generates a getter, which is probably not intended.
From API javadoc for java.io.Serializable: It is also strongly advised that explicit serialVersionUID declarations use the private modifier where possible, since such declarations apply only to the immediately declaring class--serialVersionUID fields are not useful as inherited members.
Classes that implement Serializable should define a serialVersionUID. Deserialization uses this number to ensure that a loaded class corresponds exactly to a serialized object. If you don't define serialVersionUID, the system will make one by hashing most of your class's features. Then if you change anything, the UID will change and Java won't let you reload old data.
An example of a missing serialVersionUID:
class MyClass imlements Serializable {
// missing serialVersionUID
}
Checks for catching a ArrayIndexOutOfBoundsException. Catching ArrayIndexOutOfBoundsException should be avoided in the first place by checking the array size before accessing an array element. Catching the exception may mask underlying errors.
Checks for catching a Error. In most cases that is much too broad, and is also dangerous because it can catch exceptions such as ThreadDeath and OutOfMemoryError.
Checks for catching a Exception. In most cases that is too broad or general. It should usually be restricted to framework or infrastructure code, rather than application code.
Dubious catching of IllegalMonitorStateException. IllegalMonitorStateException is generally only thrown in case of a design flaw in your code (calling wait or notify on an object you do not hold a lock on).
Checks for catching a IndexOutOfBoundsException. Catching IndexOutOfBoundsException should be avoided in the first place by checking for a valid index before accessing an indexed element. Catching the exception may mask underlying errors.
Checks for catching a NullPointerException. Catching NullPointerException is never appropriate. It should be avoided in the first place with proper null checking, and it can mask underlying errors.
Checks for catching a RuntimeException. In most cases that is too broad or general. It should usually be restricted to framework or infrastructure code, rather than application code.
Checks for catching a Throwable. In most cases that is much too broad, and is also dangerous because it can catch exceptions such as ThreadDeath and OutOfMemoryError.
Checks for an exception constructor call without a throw as the last statement within a catch block. This rule treats any constructor call for a class named xxxException as an exception constructor call.
Example of violations:
void execute() {
try { } catch(Exception e) { new Exception(e) } // violation
}
try {
doStuff()
} catch(DaoException e) {
log.warning("Ooops", e)
new ServiceException(e) // violation
} catch(Exception e) {
new SystemException(e) // violation
}
try {
doStuff()
} catch(Exception e) { throw new DaoException(e) } // ok
A common Groovy mistake when throwing exceptions is to forget the new keyword. For instance, throw RuntimeException() instead of throw new RuntimeException(). If the error path is not unit tested then the production system will throw a Method Missing exception and hide the root cause. This rule finds constructs like throw RuntimeException() that look like a new keyword was meant to be used but forgotten.
The following code will all cause violations:
throw RuntimeException() // ends in Exceptions, first letter Capitalized
throw RuntimeFailure() // ends in Failure, first letter Capitalized
throw RuntimeFault(foo) // ends in Fault, first letter Capitalized
The following code will not cause any exceptions:
throw new RuntimeException()
throw runtimeFailure() // first letter lowercase, assumed to be method call
Returning null from a catch block often masks errors and requires the client to handle error codes. In some coding styles this is discouraged. This rule ignores methods with void return type.
Checks for throwing an instance of java.lang.Error. This is not appropriate within normal application code. Throw an instance of a more specific exception subclass instead.
The option element is a child of the report element and defines a report-specific option for a report.
org.codenarc.report.XmlReportWriter supports the following options:
Attribute
Description
Required
outputFile
The path and filename for the output report file.
No
title
The title for the output report.
No
writeToStandardOut
Set to "true" or true to write out the report to stdout (System.out) instead of writing to a file.
No
Example
Here is an example Ant XML build file illustrating configuration of org.codenarc.report.XmlReportWriter. Note that the report type is specified as "xml".
The org.codenarc.report.HtmlReportWriter class (type="html") produces an HTML report containing a table with summary results by package and a separate section for each package containing violations, and then a table of the rules applied, along with their descriptions.
The option element is a child of the report element and defines a report-specific option for a report.
org.codenarc.report.HtmlReportWriter supports the following options:
Attribute
Description
Required
maxPriority
The maximum priority level for violations in the report. For instance, setting maxPriority to 2 will result in the report containing only priority 1 and 2 violations (and omitting violations with priority 3).
3
outputFile
The path and filename for the output report file.
No
title
The title for the output report.
No
writeToStandardOut
Set to true to write out the report to stdout (System.out) instead of writing to a file.
No
includeSummaryByPackage
Set to false to exclude the violation summary for each package within the "Summary" section of the report. It defaults to true.
Example
Here is an example Ant XML build file illustrating configuration of org.codenarc.report.HtmlReportWriter. Note that the report type is specified as "html".
Finds empty string literals which are being added. This is an inefficient way to convert any type to a String.
Examples:
// do not add empty strings to things
def a = '' + 123
def b = method('' + property)
// these examples are OK and do not trigger violations
def c = 456.toString()
def d = property?.toString() ?: ""
Violations occur when method calls to append(Object) are chained together with literals as parameters. The chained calls can be joined into one invocation.
Example of violations:
writer.append('foo').append('bar') // strings can be joined
writer.append('foo').append(5) // string and number can be joined
writer.append('Hello').append("$World") // GString can be joined
Example of passing code:
// usage not chained invocation
writer.append('Hello')
writer.append('World')
writer.append(null).append(5) // nulls cannot be joined
writer.append().append('Hello') // no arg append is unknown
writer.append('a', 'b').append('Hello') // two arg append is unknown
Catches concatenation of two string literals on the same line. These can safely by joined. In Java, the Java compiler will join two String literals together and place them in the Constant Pool. However, Groovy will not because the plus() method may override the + operator.
Examples:
// Violations
def a = 'Hello' + 'World' // should be 'HelloWorld'
def b = "$Hello" + 'World' // should be "${Hello}World"
def c = 'Hello' + "$World" // should be "Hello${World}"
def d = 'Hello' + 5 // should be 'Hello5'
def e = 'Hello' + '''
world // should be joined
'''
def f = '''Hello
''' + 'world' // should be joined
// Not Violations
def g = 'Hello' + // OK because of line break
'World'
def h = 'Hello' + null // OK because not a string
def i = 'Hello' + method() // OK because not a string
def j = 'Hello' - "$World" // OK because not +
It is unnecessary to instantiate BigDecimal objects. Instead just use the decimal literal or the 'G' identifier to force the type, such as 123.45 or 123.45G.
This rule does not produce violations when the parameter evaluates to an integer/long, e.g. new BigDecimal(42), new BigDecimal(42L) or new BigDecimal("42"), because using the "G" suffix on an integer value produces a BigInteger, rather than a BigDecimal, e.g. 45G. So that means there is no way to produce a BigDecimal with exactly that value using a literal.
This rule also does not produce violations when the parameter is a double, e.g. new BigDecimal(12.3). That scenario is covered by the BigDecimalInstantiation rule, because that produces an unpredictable (double) value (and so it is unsafe, rather than unnecessary).
Checks for unnecessary boolean expressions, including ANDing (&&) or ORing (||) with true, false, null, or a Map/List/String/Number literal.
This rule also checks for negation (!) of true, false, null, or a Map/List/String/Number literal.
Examples of violations include:
result = value && true // AND or OR with boolean constants
if (false || value) { .. }
return value && Boolean.FALSE
result = null && value // AND or OR with null
result = value && "abc" // AND or OR with String literal
result = value && 123 // AND or OR with Number literal
result = 678.123 || true
result = value && [x, y] // AND or OR with List literal
result = [a:123] && value // AND or OR with Map literal
result = !true // Negation of boolean constants
result = !false
result = !Boolean.TRUE
result = !null // Negation of null
result = !"abc" // Negation of String literal
result = ![a:123] // Negation of Map literal
result = ![a,b] // Negation of List literal
Since CodeNarc 0.12 (formerly BooleanInstantiation Rule in the "basic" rule set)
Checks for direct call to a Boolean constructor. Use Boolean.valueOf() or the Boolean.TRUE and Boolean.FALSE constants instead of calling the Boolean() constructor directly.
Also checks for Boolean.valueOf(true) or Boolean.valueOf(false). Use the Boolean.TRUE or Boolean.FALSE constants instead.
Here is an example of code that produces a violation:
This rule checks for excessively verbose methods of accessing the last element of an array or list. For instance, it is possible to access the last element of an array by performing array[array.length - 1], in Groovy it is simpler to either call array.last() or array[-1]. The same is true for lists. This violation is triggered whenever a get, getAt, or array-style access is used with an object size check.
Code like this all cause violations.
def x = [0, 1, 2]
def a = x.get(x.size() -1)
def b = x.get(x.length -1)
def c = x.getAt(x.size() -1)
def d = x.getAt(x.length -1)
def f = x[(x.size() -1]
def d = x[(x.length -1]
All of this code is fine though:
def x = [0, 1, 2]
def a = x.last()
def b = x[-1]
def c = x.getAt(-1)
def d = x.get(z.size() -1) // different objects
def e = x.get(z.length -1) // different objects
def f = x.getAt(z.size() -1) // different objects
Violations are triggered when a catch block does nothing but throw the original exception. In this scenario there is usually no need for a catch block, just let the exception be thrown from the original code. This condition frequently occurs when catching an exception for debugging purposes but then forgetting to take the catch statement out.
Some method calls to Object.collect(Closure) can be replaced with the spread operator. For instance, list.collect it.multiply(2) can be replaced by list*.multiply(2).
[1, 2, 3].collect { it * it } // OK, closure parameter is referenced twice
[1, 2, 3].mapMethod { it.multiply(5) } // OK, method call is not collect
[1, 2, 3].collect(5) // OK, collect parameter is not a closure
// OK, the closure is not a simple one line statement
[1, 2, 3].collect { println it; it.multiply(5) }
// OK, closure has too many arguments
[1, 2, 3].collect { a, b -> a.multiply(b) }
// OK, closure statement references parameter multiple times
[1, 2, 3].collect { it.multiply(it) }
// OK, it is referenced several times in the closure
[1, 2, 3].collect { it.multiply(2).multiply(it) }
["1", "2", "3"].collect { it.bytes.foo(it) }
// OK, chained methods are too complex to analyze at this point
[1, 2, 3].collect { it.multiply(2).multiply(4) }
// in general the above examples can be rewritten like this:
[1, 2, 3]*.multiply(2)
["1", "2", "3"]*.bytes
Checks for useless calls to collections. For any collection c, calling c.containsAll(c) should always be true, and c.retainAll(c) should have no effect.
This rule detects when a constructor is not necessary; i.e., when there's only one constructor, it's public, has an empty body, and takes no arguments, or else contains only a single call to super().
Example of violations:
class MyClass {
public MyClass() { // violation; constructor is not necessary
}
}
class MyClass2 extends OtherClass {
MyClass2() { // violation; constructor is not necessary
super()
}
}
If a field has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance, 'static def constraints = ' is redundant and can be simplified to 'static constraints = .
Example of violations:
class MyClass {
// def is redundant
static def constraints = { }
// def and private is redundant
def private field1 = { }
// def and protected is redundant
def protected field2 = { }
// def and public is redundant
def public field3 = { }
// def and static is redundant
def static field4 = { }
// def and type is redundant
def Object field5 = { }
}
If a method has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private method() ' is redundant and can be simplified to 'private method() '.
Examples of violations:
// def and private is redundant
def private method1() { return 4 }
// def and protected is redundant
def protected method2() { return 4 }
// def and public is redundant
def public method3() { return 4 }
// def and static is redundant
def static method4() { return 4 }
// def and type is redundant
def Object method5() { return 4 }
class MyClass {
def MyClass() {} // def is redundant
}
If a variable has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private n = 2' is redundant and can be simplified to 'private n = 2'.
Examples of violations:
// def and private is redundant
def private string1 = 'example'
// def and protected is redundant
def protected string2 = 'example'
// def and public is redundant
def public string3 = 'example'
// def and static is redundant
def static string4 = 'example'
// def and final is redundant
def final string5 = 'example'
// def and a type is redundant
def String string6 = 'example'
To make a reference to a class, it is unnecessary to specify the '.class' identifier. For instance String.class can be shortened to String.
Example of violations:
// The '.class' identifier is unnecessary, violation occurs
def x = String.class
// Ok, unnecessary '.class' identifier has been excluded
def x = String
When an if statement block ends with a return statement, then the else is unnecessary. The logic in the else branch can be run without being in a new scope.
Example of violations:
if(value){
println 'Executing if logic...'
return true
} else {
println 'Executing else logic...'
}
// can be replaced by:
if(value){
println 'Executing if logic...'
return true
}
println 'Executing else logic...'
It is unnecessary to instantiate Float objects. Instead just use the float literal with the 'F' identifier to force the type, such as 123.45F or 0.42f.
Checks for explicit calls to getter/accessor methods which can, for the most part, be replaced by property access. A getter is defined as a method call that matches get[A-Z] but not getClass() or get[A-Z][A-Z] such as getURL(). Getters do not take method arguments.
String objects should be created with single quotes, and GString objects created with double quotes. Creating normal String objects with double quotes is confusing to readers.
Example of violations:
def a = "I am a string" // violation
// violation
def b = """
I am a string
"""
def c = "I am a ' string" // OK
def d = """I am a ' string""" // OK
def e = """I am a ' string""" // OK
def f = "I am a \$ string" // OK
// OK
def g = """
I am a \$ string
"""
// OK
def h = """
I am a $string
"""
def i = 'i am a string'
def j = '''i am a
string
'''
Checks for unnecessary if statements. The entire if statement, or at least the if or else block, are considered unnecessary for the four scenarios described below.
(1) When the if and else blocks contain only an explicit return of true and false constants. These cases can be replaced by a simple return statement. Examples of violations include:
if (someExpression) // can be replaced by: return someExpression
return true
else
return false
if (someExpression) { // can be replaced by: return !someExpression
return false
} else {
return true
}
if (someExpression) { // can be replaced by: return someExpression
return Boolean.TRUE
} else {
return Boolean.FALSE
}
(2) When the if statement is the last statement in a block and the if and else blocks are only true and false expressions. This is an implicit return of true/false. For example, the if statement in the following code can be replaced by someExpression or someExpression as boolean:
def myMethod() {
doSomething()
if (someExpression)
true
else false
}
(3) When the second-to-last statement in a block is an if statement with no else, where the block contains a single return statement, and the last statement in the block is a return statement, and one return statement returns a true expression and the other returns a false expression. This check is disabled by setting checkLastStatementImplicitElse to false. For example, the if statement in the following code can be replaced by return expression1:
(4) When either the if block or else block of an if statement that is not the last statement in a block contain only a single constant or literal expression. For example, the if statement in the following code has no effect and can be removed:
def myMethod() {
if (someExpression) { 123 }
doSomething()
}
This rule finds instanceof checks that cannot possibly evaluate to true. For instance, checking that (!variable instanceof String) will never be true because the result of a not expression is always a boolean.
Example of violations:
if (!variable instanceof String) { ... } // always false
def x = !variable instanceof String // always false
if (!variable instanceof Boolean) { ... } // always true
def x = !variable instanceof Boolean // always true
// this code is OK
if (!(variable instanceof String)) { ... }
Violations are triggered when an excessive set of consecutive statements all reference the same variable. This can be made more readable by using a with or identity block. By default, 5 references are allowed. You can override this property using the maxReferencesAllowed> property on the rule.
Groovy contains the safe dereference operator. It can be used in boolean conditional statements to safely replace explicit x == null tests. Also, testing the 'this' or 'super' reference for null equality is pointless and can be removed.
Examples of violations:
if (obj != null && obj.method()) { }
if (obj != null && obj.prop) { }
// this is pointless and won't avoid NullPointerException
if (obj.method() && obj != null ) { }
if (this == null) { }
if (null == this) { }
if (this != null) { }
if (null != this) { }
if (super == null) { }
if (null == super) { }
if (super != null) { }
if (null != super) { }
Examples of acceptable code:
// null check it OK
if (obj != null) { }
// null safe dereference in if is OK
if (obj?.method()) { }
// null safe dereference in ternary is OK
(obj?.prop && obj?.prop2) ? x : y
// obj is reused in a parameter list, so OK
if (obj != null && obj.method() && isValid(obj)) { }
// rule is not so complex yet...
(obj != null && obj.prop && obj.method()) ? x : y
There is no need to check for null before an instanceof; the instanceof keyword returns false when given a null argument.
Example:
if (x != null && x instanceof MyClass) {
// should drop the "x != null" check
}
if (x instanceof MyClass && x != null) {
// should drop the "x != null" check
}
// should drop the "x != null" check
(x != null && x instanceof MyClass) ? foo : bar
if (x != null && x instanceof MyClass && x.isValid()) {
// this is OK and causes no violation because the x.isValid() requires a non null reference
}
Checks for explicit package reference for classes that Groovy imports by default, such as java.lang.String, java.util.Map and groovy.lang.Closure, as well as classes that were explicitly imported.
You do not need to specify the package for any 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.
Does not catch class declarations that explicitly extend java.lang.Object. For instance, class MyClass extends java.lang.Object . Just don't do that, okay?
Does not catch class declarations that explicitly extend groovy.lang.Script. For instance, class MyScript extends groovy.lang.Script. Don't do that, either!
Does not catch unnecessary package references if they are the types of anonymous inner class definitions, for older versions of Groovy ( 1.7.10?). For instance, <<<def runnable = new java.lang.Runnable() ... >>.
In Groovy, the return keyword is often optional. If a statement is the last line in a method or closure then you do not need to have the return keyword.
Method contains a pointless self-assignment to a variable or property. Either the code is pointless or the equals()/get() method has been overridden to have a side effect, which is a terrible way to code getters and violates the contract of equals().
Examples:
x = x // violation
def method(y) {
y = y // violation
}
a.b.c = a.b.c // violation
x = y // acceptable
a.b = a.zz // acceptable
a.b = a().b // acceptable
Semicolons as line terminators are not required in Groovy: remove them. Do not use a semicolon as a replacement for empty braces on for and while loops; this is a confusing practice.
The rule contains a String property called 'excludePattern'. Any source code line matching this pattern will not trigger a violation. The default value is '\s?\*.*|/\*.*|.*//.*|.*\*/.*' This is to filter out comments. Any source line that even looks like it is a comment is ignored.
\s?*.* == whitespace plus star character plus anything /*.* == any line that contains the /* sequence .*//.* == any line that contains the // sequence .**/.* == any line that contains the */ sequence
Example of violations:
package my.company.server; // violation
import java.lang.String; // violation
println(value) ; // violation
for (def x : list); // violation
// this code is OK
println(value); println (otherValue)
This rule finds usages of String.substring(int) and String.substring(int, int) that can be replaced by use of the subscript operator. For instance, var.substring(5) can be replaced with var[5..-1].
Note that the String.substring(beginIndex,endIndex) method specifies a range of beginIndex..endIndex-1, while Groovy's String subscript specifies an inclusive range. So, "123456".substring(1, 5) is equivalent to "123456"[1..4].
Example of violations:
myVar.substring(5) // can use myVar[5..-1] instead
myVar.substring(1, 5) // can use myVar[1..4] instead
Since CodeNarc 0.12 (formerly StringInstantiation Rule in the "basic" rule set)
Checks for direct call to the String constructor that accepts a String literal. In almost all cases, this is unnecessary. Use a String literal (e.g., "...") instead of calling the corresponding String constructor (new String("..")) directly.
Here is an example of code that produces a violation:
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. These cases can be replaced by a simple boolean expression. Examples of violations include:
x==99 ? true : false // can be replaced by: x==99
x && y ? true : false // can be replaced by: x && y
x||y ? false : true // can be replaced by: !(x||y)
x >= 1 ? true: false // can be replaced by: x >= 1
x < 99 ? Boolean.TRUE : Boolean.FALSE // can be replaced by: x < 99
!x ? true : false // can be replaced by: !x
The rule also checks for ternary expressions where the true and false expressions are the same constant or variable. Examples include:
x ? '123' : '123' // can be replaced by: '123'
x ? null : null // can be replaced by: null
x ? 23 : 23 // can be replaced by: 23
x ? MAX_VALUE : MAX_VALUE // can be replaced by: MAX_VALUE
ready ? minValue : minValue // can be replaced by: minValue
The field is marked as transient, but the class isn't Serializable, so marking it as transient has no effect. This may be leftover marking from a previous version of the code in which the class was transient, or it may indicate a misunderstanding of how serialization works.
Some Java frameworks change the semantics of the transient keyword. For instance, when using Terracotta the transient keyword may have slightly different semantics. You may need to turn this rule off depending on which Java frameworks are in use.
Examples:
class MyClass {
// class not serializable, violation occurs
transient String property
}
class MySerializableClass implements Serializable {
// OK, class is serializable
transient String property
}
Checks that Grails domain classes redefine equals().
Ignores classes annotated with @EqualsAndHashCode or @Canonical.
This rule sets the default value of applyToFilesMatching to only match files under the 'grails-app/domain' folder. You can override this with a different regular expression value if appropriate.
Checks that Grails domain classes redefine toString().
Ignores classes annotated with @ToString or @Canonical.
This rule sets the default value of applyToFilesMatching to only match files under the 'grails-app/domain' folder. You can override this with a different regular expression value if appropriate.
Forbids usage of SQL reserved keywords as class or field names in Grails domain classes. Naming a domain class (or its field) with such a keyword causes SQL schema creation errors and/or redundant table/column name mappings.
Note: due to limited type information available during CodeNarc's operation, this rule will report fields of type java.io.Serializable, but not of its implementations. Please specify any implementations used as domain properties in additionalHibernateBasicTypes.
Property
Description
Default Value
additionalHibernateBasicTypes
Comma-separated list of simple class names of additional classes that Hibernate maps as basic types (creates a column for a field of such class). Add your custom basic types here.
''
additionalReservedSqlKeywords
Comma-separated list of additional reserved SQL keywords (just in case the 337 keywords of nowadays SQL-* standards weren't enough).
Checks that Grails Domain classes do not have Service classes injected.
This rule sets the default value of applyToFilesMatching to only match files under the 'grails-app/domain' folder. You can override this with a different regular expression value if appropriate.
Untrusted input should not be allowed to set arbitrary object fields without restriction.
Example of violations:
// Person would be a grails domain object
def person = new Person(params)
person.save()
// or using .properties
def person = Person.get(1)
person.properties = params
person.save()
NOTE: This rule has been disabled by default (i.e., by setting its enabled property to false). Given that Grails 2.x allows and encourages controller actions to be defined as methods instead of closures, this rule makes no sense for Grails 2.x projects.
Rule that checks for public methods on Grails controller classes. Static methods are ignored.
Grails controller actions and interceptors are defined as properties on the controller class. Public methods on a controller class are unnecessary. They break encapsulation and can be confusing.
Property
Description
Default Value
ignoreMethodNames
Specifies one or more (comma-separated) method names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
This rule sets the default value of applyToFilesMatching to only match files under the 'grails-app/controllers' folder. You can override this with a different regular expression value if appropriate.
This rule also sets the default value of applyToClassNames to only match class names ending in 'Controller'. You can override this with a different class name pattern (String with wildcards) if appropriate.
Rule that checks for references to the servletContext object from within Grails controller and taglib classes.
This rule is intended as a "governance" rule to enable monitoring and controlling access to the servletContext from within application source code. Storing objects in the servletContext may inhibit scalability and/or performance and should be carefully considered. Furthermore, access to the servletContext is not synchronized, so reading/writing objects from the servletConext must be manually synchronized, as described in The Definitive Guide to Grails (2nd edition).
Note that this rule does not check for direct access to the servletContext from within GSP (Groovy Server Pages) files.
Enabling this rule may make most sense in a team environment where team members exhibit a broad range of skill and experience levels. Appropriate servletContext access can be configured as exceptions to this rule by configuring either the doNotApplyToFilenames or doNotApplyToFilesMatching property of the rule. And, as always, it is easy to just turn off the rule if it does not make sense it your environment.
This rule sets the default value of applyToFilesMatching to only match files under the 'grails-app/controllers' or 'grails-app/taglib' folders. You can override this with a different regular expression value if appropriate.
NOTE: This rule has been DEPRECATED, and disabled by default (i.e., by setting its enabled property to false). Please email the CodeNarc User Mailing List if you have an opinion for/against deprecation and eventual removal of this rule.
Rule that checks for references to the session object from within Grails controller and taglib classes.
This rule is intended as a "governance" rule to enable monitoring and controlling access to the session from within application source code. Storing objects in the session may inhibit scalability and/or performance and should be carefully considered.
Note that this rule does not check for direct access to the session from within GSP (Groovy Server Pages) files.
Enabling this rule may make most sense in a team environment where team members exhibit a broad range of skill and experience levels. Appropriate session access can be configured as exceptions to this rule by configuring either the doNotApplyToFilenames or doNotApplyToFilesMatching property of the rule. And, as always, it is easy to just turn off the rule if it does not make sense it your environment.
This rule sets the default value of applyToFilesMatching to only match files under the 'grails-app/controllers' or 'grails-app/taglib' folders. You can override this with a different regular expression value if appropriate.
Checks for non-final fields on a Grails service class. Grails service classes are singletons by default, and so they should be reentrant. In most cases, this implies (or at least encourages) that they should be stateless.
This rule ignores (i.e., does not cause violations for) the following:
All final fields (either instance or static). Note that fields that are static and non-final, however, do cause a violation.
Non-static properties (i.e., no visibility modifier specified) declared with def.
All fields with names matching the ignoreFieldNames property.
All fields with types matching the ignoreFieldTypes property.
The ignoreFieldNames property of this rule is preconfigured to ignore the standard Grails service configuration field names ('scope', 'transactional') and the standard injected bean names ('dataSource', 'sessionFactory'), as well as all other field names ending with 'Service'.
Property
Description
Default Value
ignoreFieldNames
Specifies one or more (comma-separated) field names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
Specifies one or more (comma-separated) field names to be added to the ignoreFieldNames property value. This is a special write-only property, and each call to setAddIgnoreFieldNames() adds to (rather than overwrites) the list of field names to be ignored.
null
ignoreFieldTypes
Specifies one or more (comma-separated) field types that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
This rule sets the default value of applyToFilesMatching to only match files under the 'grails-app/services' folder. You can override this with a different regular expression value if appropriate.
This rule also sets the default value of applyToClassNames to only match class names ending in 'Service'. You can override this with a different class name pattern (String with wildcards) if appropriate.
Notes
The ignoreFieldTypes property matches the field type name as indicated in the field declaration, only including a full package specification IF it is included in the source code. For example, the field declaration BigDecimal value matches an ignoreFieldTypes value of BigDecimal, but not java.lang.BigDecimal.
There is one exception for the ignoreFieldTypes property: if the field is declared with a modifier/type of def, then the type resolves to java.lang.Object.
The Collections.sort() method mutates the list and returns the list as a value. If you are assigning the result of sort() to a variable, then you probably don't realize that you're also modifying the original list as well. This is frequently the cause of subtle bugs. This violation is triggered when a sort() method call appears as the right hand side of an assignment, or when it appears as the first method call in a series of chained method calls.
Example of violations:
def a = myList.sort()
def b = myList.sort() { it }
def c = myList.sort().findAll { x < 1 }
The Collections.unique() method mutates the list and returns the list as a value. If you are assigning the result of unique() to a variable, then you probably don't realize that you're also modifying the original list as well. This is frequently the cause of subtle bugs. This violation is triggered when a unique() method call appears as the right hand side of an assignment, or when it appears as the first method call in a series of chained method calls.
Example of violations:
def a = myList.unique()
def b = myList.unique() { it }
def c = myList.unique().findAll { x < 1 }
Multiple return values can be used to set several variables at once. To use multiple return values, the left hand side of the assignment must be enclosed in parenthesis. If not, then you are not using multiple return values, you're only assigning the last element.
Example of violations:
def a, b = [1, 2] // bad, b is null
def c, d, e = [1, 2, 3] // bad, c and d are null
class MyClass {
def a, b, c = [1, 2, 3] // bad, a and b are null
}
def x = 1 // ok
def (f, g) = [1, 2] // ok
(a, b, c) = [1, 2, 3] // ok
This rule checks for explicit calls to the no-argument constructor of ArrayList. In Groovy, it is best to write new ArrayList() as [], which creates the same object.
This rule detects when the and(Object) method is called directly in code instead of using the & operator. A groovier way to express this: a.and(b) is this: a & b. This rule can be configured to ignore this.and(Object) using the ignoreThisReference property. It defaults to true, so even and(x) will not trigger a violation. The default is true because and appears commonly in Grails criteria.
This rule also ignores all calls to super.and(Object).
This rule detects when the compareTo(Object) method is called directly in code instead of using the <=>, >, >=, <, and <= operators. A groovier way to express this: a.compareTo(b) is this: a <=> b, or using the other operators. Here are some other ways to write groovier code:
a.compareTo(b) == 0 // can be replaced by: a == b
a.compareTo(b) // can be replaced by: a <=> b
a.compareTo(b) > 0 // can be replaced by: a > b
a.compareTo(b) >= 0 // can be replaced by: a >= b
a.compareTo(b) < 0 // can be replaced by: a < b
a.compareTo(b) <= 0 // can be replaced by: a <= b
This rule can be configured to ignore this.compareTo(Object) using the ignoreThisReference property. It defaults to false, so even compareTo(x) will trigger a violation.
This rule also ignores all calls to super.compareTo(Object).
This rule detects when the div(Object) method is called directly in code instead of using the / operator. A groovier way to express this: a.div(b) is this: a / b. This rule can be configured to ignore div.xor(Object) using the ignoreThisReference property. It defaults to false, so even div(x) will trigger a violation.
This rule also ignores all calls to super.div(Object).
This rule detects when the equals(Object) method is called directly in code instead of using the == or != operator. A groovier way to express this: a.equals(b) is this: a == b and a groovier way to express : !a.equals(b) is: a != b. This rule can be configured to ignore this.equals(Object) using the ignoreThisReference property. It defaults to false, so even equals(x) will trigger a violation.
This rule also ignores all calls to super.equals(Object).
This rule detects when the getAt(Object) method is called directly in code instead of using the [] index operator. A groovier way to express this: a.getAt(b) is this: a[b]. This rule can be configured to ignore this.getAt(Object) using the ignoreThisReference property. It defaults to false, so even getAt(x) will trigger a violation.
This rule also ignores all calls to super.getAt(Object).
This rule detects when the leftShift(Object) method is called directly in code instead of using the << operator. A groovier way to express this: a.leftShift(b) is this: a << b. This rule can be configured to ignore this.leftShift(Object) using the ignoreThisReference property. It defaults to false, so even leftShift(x) will trigger a violation.
This rule also ignores all calls to super.leftShift(Object).
This rule detects when the minus(Object) method is called directly in code instead of using the - operator. A groovier way to express this: a.minus(b) is this: a - b. This rule can be configured to ignore minus.xor(Object) using the ignoreThisReference property. It defaults to false, so even minus(x) will trigger a violation.
This rule also ignores all calls to super.minus(Object).
This rule detects when the multiply(Object) method is called directly in code instead of using the * operator. A groovier way to express this: a.multiply(b) is this: a * b. This rule can be configured to ignore this.multiply(Object) using the ignoreThisReference property. It defaults to false, so even multiply(x) will trigger a violation.
This rule also ignores all calls to super.multiply(Object).
This rule detects when the mod(Object) method is called directly in code instead of using the % operator. A groovier way to express this: a.mod(b) is this: a % b. This rule can be configured to ignore this.mod(Object) using the ignoreThisReference property. It defaults to false, so even mod(x) will trigger a violation.
This rule also ignores all calls to super.mod(Object).
This rule detects when the or(Object) method is called directly in code instead of using the | operator. A groovier way to express this: a.or(b) is this: a | b. This rule can be configured to ignore this.or(Object) using the ignoreThisReference property. It defaults to true, so even or(x) will not trigger a violation. This is the default because it is commonly used in Grails criteria.
This rule also ignores all calls to super.or(Object).
This rule detects when the plus(Object) method is called directly in code instead of using the + operator. A groovier way to express this: a.plus(b) is this: a + b. This rule can be configured to ignore this.plus(Object) using the ignoreThisReference property. It defaults to false, so even plus(x) will trigger a violation.
This rule also ignores all calls to super.plus(Object).
This rule detects when the power(Object) method is called directly in code instead of using the ** operator. A groovier way to express this: a.power(b) is this: a ** b. This rule can be configured to ignore this.power(Object) using the ignoreThisReference property. It defaults to false, so even power(x) will trigger a violation.
This rule also ignores all calls to super.power(Object).
This rule detects when the rightShift(Object) method is called directly in code instead of using the >> operator. A groovier way to express this: a.rightShift(b) is this: a >> b. This rule can be configured to ignore this.rightShift(Object) using the ignoreThisReference property. It defaults to false, so even rightShift(x) will trigger a violation.
This rule also ignores all calls to super.rightShift(Object).
This rule detects when the xor(Object) method is called directly in code instead of using the ^ operator. A groovier way to express this: a.xor(b) is this: a ^ b. This rule can be configured to ignore this.xor(Object) using the ignoreThisReference property. It defaults to false, so even xor(x) will trigger a violation.
This rule also ignores all calls to super.xor(Object).
This rule checks for explicit calls to the no-argument constructor of HashMap. In Groovy, it is best to replace new HashMap() with [:], which creates (mostly) the same object. [:] is technically a LinkedHashMap but it is very rare that someone absolutely needs an instance of HashMap and not a subclass.
This rule checks for the explicit instantiation of a LinkedHashMap using the no-arg constructor. In Groovy, it is best to replace new LinkedHashMap() with [:], which creates the same object.
This rule checks for explicit calls to the no-argument constructor of HashSet. In Groovy, it is best to replace new HashSet() with [] as Set, which creates the same object.
This rule checks for explicit calls to the no-argument constructor of LinkedList. In Groovy, it is best to replace new LinkedList() with [] as Queue, which creates the same object.
This rule checks for explicit calls to the no-argument constructor of Stack. In Groovy, it is best to replace new Stack() with [] as Stack, which creates the same object.
This rule checks for explicit calls to the no-argument constructor of TreeSet. In Groovy, it is best to replace new TreeSet() with [] as SortedSet, which creates the same object.
If a class defines a public method that follows the Java getter notation and that returns a constant, then it is cleaner to provide a Groovy property for the value rather than a Groovy method.
Example of violations:
interface Parent {
String getSomething()
String getSomethingElse()
}
class Child extends Parent {
static VALUE = 'value'
@Override
String getSomething() {
'something' // this could be simplified
}
@Override
String getSomethingElse() {
VALUE // this could be simplified
}
int getOtherValue() {
123
}
static String getName() {
'MyName'
}
}
class Child2 extends Parent {
static VALUE = 'value'
final String something = 'something' // this is cleaner
final String somethingElse = VALUE // this is cleaner
final int otherValue = 123 // this is cleaner
static final String name = 'MyName' // this is cleaner
}
The groovy.lang.Immutable annotation has been deprecated and replaced by groovy.transform.Immutable. Do not use the Immutable in groovy.lang.
Example of violations:
@Immutable
class Person { }
@groovy.lang.Immutable
class Person { }
import groovy.lang.Immutable as Imtl
@Imtl
class Person { }
// the following code is OK
@groovy.transform.Immutable
class Person { }
import groovy.transform.Immutable
@Immutable
class Person { }
import groovy.transform.*
@Immutable
class Person { }
import groovy.transform.Immutable as Imtl
@Imtl
class Person { }
The File.createTempFile() method is insecure, and has been deprecated by the ESAPI secure coding library. It has been replaced by the ESAPI Randomizer.getRandomFilename(String) method.
Reports usages of java.util.Random, which can produce very predictable results. If two instances of Random are created with the same seed and sequence of method calls, they will generate the exact same results. Use java.security.SecureRandom instead, which provides a cryptographically strong random number generator. SecureRandom uses PRNG, which means they are using a deterministic algorithm to produce a pseudo-random number from a true random seed. SecureRandom produces non-deterministic output.
By default, this rule ignores test classes are ignored.
def r1 = new Random()
def r2 = new java.util.Random()
Math.random()
java.lang.Math.random()
// this is OK
new java.security.SecureRandom()
new SecureRandom()
This rule reports violations of the Enterprise JavaBeans specification by using the java.io package to access files or the file system.
The Enterprise JavaBeans specification requires that every bean provider follow a set of programming guidelines designed to ensure that the bean will be portable and behave consistently in any EJB container [1].
In this case, the program violates the following EJB guideline: "An enterprise bean must not use the java.io package to attempt to access files and directories in the file system."
A requirement that the specification justifies in the following way: "The file system APIs are not well-suited for business components to access data. Business components should use a resource manager API, such as JDBC, to store data."
REFERENCES
Standards Mapping - Common Weakness Enumeration - (CWE) CWE ID 576
The Enterprise JavaBeans 2.1 Specification Sun Microsystems
By default, this rule is not applied to tests and test cases.
Example of violations:
FileSystem.getFileSystem() // any method on FileSystem
FileSystem.fileSystem.delete(aFile) // property access of FileSystem
// shouldn't create files
new File(name)
new File(name, parent)
// don't create file readers
new FileReader(name)
// don't create file output streams
new FileOutputStream(name)
new FileOutputStream(name, true)
// don't create random access file
new RandomAccessFile(name, parent)
Finds code that violates secure coding principles for mobile code by declaring a member variable public but not final.
All public member variables in an Applet and in classes used by an Applet should be declared final to prevent an attacker from manipulating or gaining unauthorized access to the internal state of the Applet.
References:
Standards Mapping - Common Weakness Enumeration - (CWE) CWE ID 493
G. McGraw Securing Java. Chapter 7: Java Security Guidelines
The permissions classes such as java.security.Permission and java.security.BasicPermission are designed to be extended. Classes that derive from these permissions classes, however, must prohibit extension. This prohibition ensures that malicious subclasses cannot change the properties of the derived class. Classes that implement sensitive interfaces such as java.security.PrivilegedAction and java.security.PrivilegedActionException must also be declared final for analogous reasons.
Creates a violation when the program violates secure coding principles by declaring a finalize() method public.
A program should never call finalize explicitly, except to call super.finalize() inside an implementation of finalize(). In mobile code situations, the otherwise error prone practice of manual garbage collection can become a security threat if an attacker can maliciously invoke one of your finalize() methods because it is declared with public access. If you are using finalize() as it was designed, there is no reason to declare finalize() with anything other than protected access.
References:
Standards Mapping - Common Weakness Enumeration - (CWE) CWE ID 583
G. McGraw Securing Java. Chapter 7: Java Security Guidelines
The finalize() method should only be called by the JVM after the object has been garbage collected.
While the Java Language Specification allows an object's finalize() method to be called from outside the finalizer, doing so is usually a bad idea. For example, calling finalize() explicitly means that finalize() will be called more than once: the first time will be the explicit call and the last time will be the call that is made after the object is garbage collected.
References: Standards Mapping - Common Weakness Enumeration - (CWE) CWE ID 586
Web applications should never call System.exit(). A call to System.exit() is probably part of leftover debug code or code imported from a non-J2EE application.
Standards Mapping - OWASP Top 10 2004 - (OWASP 2004) A9 Application Denial of Service
Standards Mapping - Security Technical Implementation Guide Version 3 - (STIG 3) APP6080 CAT II
Standards Mapping - Common Weakness Enumeration - (CWE) CWE ID 382
Standards Mapping - Payment Card Industry Data Security Standard Version 1.1 - (PCI 1.1) Requirement 6.5.9
Triggers a violation when an array is declared public, final, and static.
In most cases an array declared public, final and static is a bug. Because arrays are mutable objects, the final constraint requires that the array object itself be assigned only once, but makes no guarantees about the values of the array elements. Since the array is public, a malicious program can change the values stored in the array. In most situations the array should be made private.
Example of violations:
class MyClass {
public static final String[] myArray = init()
public static final def myArray = [] as String[]
}
[SRC]int complete(String buffer, int cursor, List candidates) {
[MSG]Violation in class RegexCompletor. Method parameter [cursor] is never referenced in the method complete of class grails.build.interactive.completors.RegexCompletor
[MSG]Violation in class PluginBuildSettings. Method parameter [pluginDirPath] is never referenced in the method getPluginInfos of class grails.util.PluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.cli.interactive.InteractiveMode. getMetaClassRegistry() can probably be rewritten as metaClassRegistry
[MSG]Violation in class org.codehaus.groovy.grails.cli.interactive.InteractiveMode. getCommandLineParser() can probably be rewritten as commandLineParser
[MSG]Violation in class ClassNameCompletor. Method parameter [res] is never referenced in the method shouldInclude of class org.codehaus.groovy.grails.cli.interactive.completors.ClassNameCompletor
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginDirPath] is never referenced in the method getPluginInfos of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginDirPath] is never referenced in the method getSupportedPluginInfos of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginDirPath] is never referenced in the method getPluginBaseDirectories of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginDirPath] is never referenced in the method getPluginDirectories of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginDirPath] is never referenced in the method getImplicitPluginDirectories of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [basedir] is never referenced in the method getArtefactResources of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginsDirPath] is never referenced in the method getPluginXmlMetadata of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [grailsHome] is never referenced in the method getAvailableScripts of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginDirPath] is never referenced in the method getAvailableScripts of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [basedir] is never referenced in the method getAvailableScripts of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginDirPath] is never referenced in the method getPluginScripts of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginDirPath] is never referenced in the method getPluginResourceBundles of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginsDirPath] is never referenced in the method getPluginSourceFiles of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginsDirPath] is never referenced in the method getPluginJarFiles of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [basedir] is never referenced in the method getPluginDescriptors of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginsDirPath] is never referenced in the method getPluginDescriptors of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginsDirPath] is never referenced in the method getPluginLibDirectories of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginsDirPath] is never referenced in the method getPluginI18nDirectories of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class GrailsPluginUtils. Method parameter [pluginsDirPath] is never referenced in the method getPluginDirForName of class org.codehaus.groovy.grails.plugins.GrailsPluginUtils
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getSupportedPluginInfos() can probably be rewritten as supportedPluginInfos
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBaseDirectories() can probably be rewritten as pluginBaseDirectories
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBaseDirectories() can probably be rewritten as pluginBaseDirectories
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getImplicitPluginDirectories() can probably be rewritten as implicitPluginDirectories
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginResourceBundles() can probably be rewritten as pluginResourceBundles
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginLibDirectories() can probably be rewritten as pluginLibDirectories
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginI18nDirectories() can probably be rewritten as pluginI18nDirectories
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtils. getPluginBuildSettings() can probably be rewritten as pluginBuildSettings
[MSG]Violation in class VersionComparator. Method parameter [obj] is never referenced in the method equals of class org.codehaus.groovy.grails.plugins.VersionComparator
[SRC]Field field = getClass().getSuperclass().getDeclaredFiel..Transitive")
[MSG]Violation in class org.codehaus.groovy.grails.resolve.EnhancedDefaultDependencyDescriptor. getSuperclass() can probably be rewritten as superclass
[SRC]Field field = getClass().getSuperclass().getDeclaredFiel..isChanging")
[MSG]Violation in class org.codehaus.groovy.grails.resolve.EnhancedDefaultDependencyDescriptor. getSuperclass() can probably be rewritten as superclass
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManager. getPluginDependencyDescriptors() can probably be rewritten as pluginDependencyDescriptors
[MSG]Violation in class PluginInstallEngine. Method parameter [pluginName] is never referenced in the method resolvePluginJarDependencies of class org.codehaus.groovy.grails.resolve.PluginInstallEngine
[MSG]Violation in class org.codehaus.groovy.grails.resolve.PluginInstallEngine. Boolean.getBoolean(String) is a confusing API for reading System properties. Prefer the System.getProperty(String) API.
[MSG]Violation in class PluginInstallEngine. Method parameter [pluginName] is never referenced in the method processPluginDependencies of class org.codehaus.groovy.grails.resolve.PluginInstallEngine
[SRC]for(IvyNode node in confReport.getUnresolvedDependencies()) {
[MSG]Violation in class org.codehaus.groovy.grails.resolve.ResolveException. getUnresolvedDependencies() can probably be rewritten as unresolvedDependencies
[MSG]Violation in class org.codehaus.groovy.grails.resolve.ResolveException. getFailedArtifactsReports() can probably be rewritten as failedArtifactsReports
[MSG]Violation in class org.codehaus.groovy.grails.commons.cfg.MapBasedSmartPropertyOverrideConfigurer. getBeansConfig() can probably be rewritten as beansConfig
[MSG]Violation in class org.codehaus.groovy.grails.commons.metaclass.MetaClassEnhancer$1. getDeclaringClass() can probably be rewritten as declaringClass
[MSG]Violation in class org.codehaus.groovy.grails.compiler.GrailsProjectCompiler. getArtefactResourcesForCurrentEnvironment() can probably be rewritten as artefactResourcesForCurrentEnvironment
[MSG]Violation in class org.codehaus.groovy.grails.compiler.GrailsProjectCompiler. getExtraDependencies() can probably be rewritten as extraDependencies
[MSG]Violation in class org.codehaus.groovy.grails.compiler.GrailsProjectPackager. getSupportedPluginInfos() can probably be rewritten as supportedPluginInfos
[MSG]Violation in class org.codehaus.groovy.grails.compiler.GrailsProjectPackager. getSupportedPluginInfos() can probably be rewritten as supportedPluginInfos
[MSG]Violation in class org.codehaus.groovy.grails.exceptions.DefaultStackTracePrinter. The cyclomatic complexity for method [prettyPrintCodeSnippet] is [21]
[SRC]String formatCodeSnippetEnd(Resource resource, int lineNumber) {
[MSG]Violation in class DefaultStackTracePrinter. Method parameter [resource] is never referenced in the method formatCodeSnippetEnd of class org.codehaus.groovy.grails.exceptions.DefaultStackTracePrinter
[SRC]String formatCodeSnippetEnd(Resource resource, int lineNumber) {
[MSG]Violation in class DefaultStackTracePrinter. Method parameter [lineNumber] is never referenced in the method formatCodeSnippetEnd of class org.codehaus.groovy.grails.exceptions.DefaultStackTracePrinter
[MSG]Violation in class org.codehaus.groovy.grails.exceptions.DefaultStackTracePrinter. getErrorCollector() can probably be rewritten as errorCollector
[MSG]Violation in class org.codehaus.groovy.grails.exceptions.DefaultStackTracePrinter. getErrorCollector() can probably be rewritten as errorCollector
[SRC]def locations = new ArrayList(settings.pluginDirectories..olutePath })
[MSG]Violation in class org.codehaus.groovy.grails.plugins.CoreGrailsPlugin. The call to collect could probably be rewritten as a spread expression: settings.pluginDirectories*.absolutePath
[MSG]Violation in class DefaultPluginPublisher. Method parameter [pluginName] is never referenced in the method getPluginMetadata of class org.codehaus.groovy.grails.plugins.publishing.DefaultPluginPublisher
[MSG]Violation in class org.codehaus.groovy.grails.plugins.publishing.DefaultPluginPublisher. getInputStream() can probably be rewritten as inputStream
[MSG]Violation in class org.codehaus.groovy.grails.plugins.publishing.PluginDescriptorGenerator. The cyclomatic complexity for method [generatePluginXml] is [28]
[MSG]Violation in class PluginPackager. Method parameter [classesDir] is never referenced in the method packageSource of class org.codehaus.groovy.grails.plugins.publishing.PluginPackager
[MSG]Violation in class PluginPackager. Method parameter [targetDir] is never referenced in the method packageSource of class org.codehaus.groovy.grails.plugins.publishing.PluginPackager
[MSG]Violation in class org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator. getTemplateNames() can probably be rewritten as templateNames
[MSG]Violation in class org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class BlockQuoteFilter. Method parameter [context] is never referenced in the method handleMatch of class grails.doc.BlockQuoteFilter
[MSG]Violation in class TextileLinkFilter. Method parameter [context] is never referenced in the method handleMatch of class grails.doc.TextileLinkFilter
[MSG]Violation in class HeaderFilter. Method parameter [filterContext] is never referenced in the method handleMatch of class grails.doc.filters.HeaderFilter
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.HibernateGormStaticApi. getSessionFactory() can probably be rewritten as sessionFactory
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.HibernateGormStaticApi. getGrailsApplication() can probably be rewritten as grailsApplication
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.HibernateGormValidationApi. getSessionFactory() can probably be rewritten as sessionFactory
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.HibernateGormValidationApi. getGrailsApplication() can probably be rewritten as grailsApplication
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.HibernateGormInstanceApi. getSessionFactory() can probably be rewritten as sessionFactory
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.HibernateGormInstanceApi. getGrailsApplication() can probably be rewritten as grailsApplication
[MSG]Violation in class GORMEnhancingBeanPostProcessor. Method parameter [beanName] is never referenced in the method postProcessBeforeInitialization of class org.codehaus.groovy.grails.orm.hibernate.cfg.GORMEnhancingBeanPostProcessor
[MSG]Violation in class GORMEnhancingBeanPostProcessor. Method parameter [beanName] is never referenced in the method postProcessAfterInitialization of class org.codehaus.groovy.grails.orm.hibernate.cfg.GORMEnhancingBeanPostProcessor
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.HibernateMappingBuilder. The cyclomatic complexity for method [handleMethodMissing] is [46]
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.NamedCriteriaProxy. getPreparedCriteriaClosure() can probably be rewritten as preparedCriteriaClosure
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.NamedCriteriaProxy. getPreparedCriteriaClosure() can probably be rewritten as preparedCriteriaClosure
[MSG]Violation in class org.codehaus.groovy.grails.plugins.orm.hibernate.HibernatePluginSupport. The cyclomatic complexity for method [doWithSpring] is [55]
[MSG]Violation in class org.codehaus.groovy.grails.plugins.orm.hibernate.HibernatePluginSupport. getSpringConfig() can probably be rewritten as springConfig
[MSG]Violation in class org.codehaus.groovy.grails.plugins.orm.hibernate.HibernatePluginSupport. getSpringConfig() can probably be rewritten as springConfig
[MSG]Violation in class org.codehaus.groovy.grails.plugins.orm.hibernate.HibernatePluginSupport. getUnrefreshedApplicationContext() can probably be rewritten as unrefreshedApplicationContext
[MSG]Violation in class org.codehaus.groovy.grails.plugins.orm.hibernate.HibernatePluginSupport. getSpringConfig() can probably be rewritten as springConfig
[MSG]Violation in class org.codehaus.groovy.grails.plugins.orm.hibernate.HibernatePluginSupport. The call to collect could probably be rewritten as a spread expression: explicitLocations*.toString()
[MSG]Violation in class org.codehaus.groovy.grails.plugins.orm.hibernate.HibernatePluginSupport. getSpringConfig() can probably be rewritten as springConfig
[MSG]Violation in class org.codehaus.groovy.grails.plugins.orm.hibernate.HibernatePluginSupport. getSpringConfig() can probably be rewritten as springConfig
[SRC]for (PersistentEntity entity in mappingContext.getPersis..ntities()) {
[MSG]Violation in class org.codehaus.groovy.grails.plugins.orm.hibernate.HibernatePluginSupport. getPersistentEntities() can probably be rewritten as persistentEntities
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.async.ControllersAsyncGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.async.GrailsAsyncContext. getApplicationContext() can probably be rewritten as applicationContext
[SRC]GrailsWebRequest webRequest = new GrailsWebRequest(reque..etContext())
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.async.GrailsAsyncContext. getServletContext() can probably be rewritten as servletContext
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.async.GrailsAsyncContext. getTargetResponse() can probably be rewritten as targetResponse
[MSG]Violation in class ControllersAsyncApi. Method parameter [instance] is never referenced in the method startAsync of class org.codehaus.groovy.grails.plugins.web.async.api.ControllersAsyncApi
[MSG]Violation in class ControllersGrailsPlugin. Method parameter [ctx] is never referenced in the method enhanceDomainWithBinding of class org.codehaus.groovy.grails.plugins.web.ControllersGrailsPlugin
[SRC]protected Object invalidTokenInternal(Closure callable) { model }
[MSG]Violation in class ValidResponseHandler. Method parameter [callable] is never referenced in the method invalidTokenInternal of class org.codehaus.groovy.grails.web.metaclass.ValidResponseHandler
[MSG]Violation in class WebMetaUtils. Method parameter [action] is never referenced in the method prepareCommandObjectBindingAction of class org.codehaus.groovy.grails.web.plugins.support.WebMetaUtils
[MSG]Violation in class WebMetaUtils. Method parameter [application] is never referenced in the method registerCommonWebProperties of class org.codehaus.groovy.grails.web.plugins.support.WebMetaUtils
[MSG]Violation in class org.codehaus.groovy.grails.web.plugins.support.WebMetaUtils. The String.substring(int, int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.converters.ConvertersGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class org.codehaus.groovy.grails.plugins.converters.ConvertersGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class org.codehaus.groovy.grails.plugins.converters.ConvertersGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class ConvertersPluginSupport. Method parameter [application] is never referenced in the method enhanceApplication of class org.codehaus.groovy.grails.plugins.converters.ConvertersPluginSupport
[MSG]Violation in class org.codehaus.groovy.grails.web.converters.JSONParsingParameterCreationListener. getRequest() can probably be rewritten as request
[MSG]Violation in class org.codehaus.groovy.grails.web.converters.XMLParsingParameterCreationListener. getRequest() can probably be rewritten as request
[MSG]Violation in class org.codehaus.groovy.grails.plugins.datasource.DataSourceGrailsPlugin. The cyclomatic complexity for method [createDatasource] is [22]
[MSG]Violation in class org.codehaus.groovy.grails.plugins.datasource.DataSourceGrailsPlugin. Methods calls to Class.forName(...) can create resource leaks and should almost always be replaced with calls to ClassLoader.loadClass(...)
[MSG]Violation in class org.codehaus.groovy.grails.plugins.datasource.DataSourceGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class org.codehaus.groovy.grails.plugins.datasource.DataSourceGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class org.codehaus.groovy.grails.plugins.DomainClassGrailsPlugin. The cyclomatic complexity for method [addRelationshipManagementMethods] is [27]
[MSG]Violation in class org.codehaus.groovy.grails.plugins.DomainClassGrailsPlugin. getRequestAttributes() can probably be rewritten as requestAttributes
[MSG]Violation in class org.codehaus.groovy.grails.plugins.DomainClassGrailsPlugin. getRequestAttributes() can probably be rewritten as requestAttributes
[MSG]Violation in class FilterToHandlerAdapter. Method parameter [o] is never referenced in the method preHandle of class org.codehaus.groovy.grails.plugins.web.filters.FilterToHandlerAdapter
[MSG]Violation in class FilterToHandlerAdapter. Method parameter [o] is never referenced in the method postHandle of class org.codehaus.groovy.grails.plugins.web.filters.FilterToHandlerAdapter
[MSG]Violation in class FilterToHandlerAdapter. Method parameter [response] is never referenced in the method afterCompletion of class org.codehaus.groovy.grails.plugins.web.filters.FilterToHandlerAdapter
[MSG]Violation in class FilterToHandlerAdapter. Method parameter [o] is never referenced in the method afterCompletion of class org.codehaus.groovy.grails.plugins.web.filters.FilterToHandlerAdapter
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.filters.FilterToHandlerAdapter. getContextPath() can probably be rewritten as contextPath
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.filters.FilterToHandlerAdapter. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.filters.FilterToHandlerAdapter. getDefaultAction() can probably be rewritten as defaultAction
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.filters.FiltersGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[SRC]ISO3166_3.entrySet().sort { a, b -> a.value.compareTo(b...) { it.key }
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.CountryTagLib. The call to collect could probably be rewritten as a spread expression: ISO3166_3.entrySet().sort(<not implemented yet for class: org.codehaus.groovy.ast.expr.ClosureExpression>)*.key
[SRC]ISO3166_3.entrySet().sort { a, b -> a.value.compareTo(b...) { it.key }
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.CountryTagLib. Parentheses in the 'collect' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.FormTagLib. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.FormatTagLib. getDecimalFormatSymbols() can probably be rewritten as decimalFormatSymbols
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.JavascriptTagLib. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.RenderTagLib. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. The call to collect could probably be rewritten as a spread expression: model.findAll(<not implemented yet for class: org.codehaus.groovy.ast.expr.ClosureExpression>)*.value
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. Parentheses in the 'errors' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. The String.substring(int, int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. The call to collect could probably be rewritten as a spread expression: it*.appliedConstraints
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. The String.substring(int, int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. The String.substring(int, int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib. getPropertyEditorRegistry() can probably be rewritten as propertyEditorRegistry
[MSG]Violation in class ControllersMimeTypesApi. Method parameter [instance] is never referenced in the method withFormat of class org.codehaus.groovy.grails.plugins.web.api.ControllersMimeTypesApi
[MSG]Violation in class ResponseMimeTypesApi. Method parameter [response] is never referenced in the method getMimeTypesInternal of class org.codehaus.groovy.grails.plugins.web.api.ResponseMimeTypesApi
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.api.ResponseMimeTypesApi. getCurrentRequest() can probably be rewritten as currentRequest
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.mimes.MimeTypesGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class org.codehaus.groovy.grails.web.mime.DefaultAcceptHeaderParser. getConfiguredMimeTypes() can probably be rewritten as configuredMimeTypes
[SRC]def version = grails.util.GrailsUtil.getGrailsVersion()
[MSG]Violation in class org.codehaus.groovy.grails.plugins.scaffolding.ScaffoldingGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class org.codehaus.groovy.grails.plugins.services.ServicesGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class MockUtils. Method parameter [testInstances] is never referenced in the method addOtherStaticMethods of class grails.test.MockUtils
[MSG]Violation in class TomcatLoader. Method parameter [listener] is never referenced in the method addPropertyChangeListener of class org.grails.plugins.tomcat.TomcatLoader
[MSG]Violation in class TomcatLoader. Method parameter [listener] is never referenced in the method removePropertyChangeListener of class org.grails.plugins.tomcat.TomcatLoader
[MSG]Violation in class org.grails.plugins.tomcat.TomcatServer. Methods calls to Class.forName(...) can create resource leaks and should almost always be replaced with calls to ClassLoader.loadClass(...)
[MSG]Violation in class org.grails.plugins.tomcat.TomcatServer. Methods calls to Class.forName(...) can create resource leaks and should almost always be replaced with calls to ClassLoader.loadClass(...)
[MSG]Violation in class UrlMappingsGrailsPlugin. Method parameter [application] is never referenced in the method createUrlMappingsHolder of class org.codehaus.groovy.grails.plugins.web.mapping.UrlMappingsGrailsPlugin
[MSG]Violation in class UrlMappingsGrailsPlugin. Method parameter [pluginManager] is never referenced in the method createUrlMappingsHolder of class org.codehaus.groovy.grails.plugins.web.mapping.UrlMappingsGrailsPlugin
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.mapping.UrlMappingsGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[MSG]Violation in class ValidationGrailsPlugin. Method parameter [ctx] is never referenced in the method addValidationMethods of class org.codehaus.groovy.grails.plugins.ValidationGrailsPlugin
[MSG]Violation in class org.codehaus.groovy.grails.plugins.ValidationGrailsPlugin. getRequestAttributes() can probably be rewritten as requestAttributes
[MSG]Violation in class org.codehaus.groovy.grails.plugins.ValidationGrailsPlugin. getRequestAttributes() can probably be rewritten as requestAttributes
[MSG]Violation in class org.codehaus.groovy.grails.plugins.ValidationGrailsPluginTests. getMetaClassRegistry() can probably be rewritten as metaClassRegistry
[SRC]ga = new DefaultGrailsApplication(gcl.getLoadedClasses(),gcl)
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.AbstractGrailsPluginTests. getLoadedClasses() can probably be rewritten as loadedClasses
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.AbstractGrailsPluginTests. getApplicationContext() can probably be rewritten as applicationContext
[SRC]ga = new DefaultGrailsApplication(gcl.getLoadedClasses(), gcl)
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.mvc.AbstractGrailsControllerTests. getLoadedClasses() can probably be rewritten as loadedClasses
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.mvc.AbstractGrailsControllerTests. getServletContext() can probably be rewritten as servletContext
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.mvc.AbstractGrailsControllerTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.mvc.AbstractGrailsControllerTests. getServletContext() can probably be rewritten as servletContext
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.mvc.AbstractGrailsControllerTests. getServletContext() can probably be rewritten as servletContext
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.AbstractGrailsTagTests. getApplicationContext() can probably be rewritten as applicationContext
[SRC]ga = new DefaultGrailsApplication(gcl.getLoadedClasses(), gcl)
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.AbstractGrailsHibernateTests. getLoadedClasses() can probably be rewritten as loadedClasses
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.AbstractGrailsHibernateTests. getUnrefreshedApplicationContext() can probably be rewritten as unrefreshedApplicationContext
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.AbstractGrailsHibernateTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.AbstractGrailsHibernateTests. getMetaClassRegistry() can probably be rewritten as metaClassRegistry
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCascadeStyle() can probably be rewritten as cascadeStyle
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCollectionRole() can probably be rewritten as collectionRole
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnSpan() can probably be rewritten as columnSpan
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getEntityName() can probably be rewritten as entityName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getGeneration() can probably be rewritten as generation
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getPropertyAccessorName() can probably be rewritten as propertyAccessorName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCascadeStyle() can probably be rewritten as cascadeStyle
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCollectionRole() can probably be rewritten as collectionRole
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnSpan() can probably be rewritten as columnSpan
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getEntityName() can probably be rewritten as entityName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getGeneration() can probably be rewritten as generation
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getPersistentClass() can probably be rewritten as persistentClass
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getPropertyAccessorName() can probably be rewritten as propertyAccessorName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnInsertability() can probably be rewritten as columnInsertability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnInsertability() can probably be rewritten as columnInsertability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnUpdateability() can probably be rewritten as columnUpdateability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnUpdateability() can probably be rewritten as columnUpdateability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnSpan() can probably be rewritten as columnSpan
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getForeignKeyName() can probably be rewritten as foreignKeyName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getIdentifierGeneratorStrategy() can probably be rewritten as identifierGeneratorStrategy
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCascadeStyle() can probably be rewritten as cascadeStyle
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnSpan() can probably be rewritten as columnSpan
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getGeneration() can probably be rewritten as generation
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnIterator() can probably be rewritten as columnIterator
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCanonicalName() can probably be rewritten as canonicalName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCheckConstraint() can probably be rewritten as checkConstraint
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getDefaultValue() can probably be rewritten as defaultValue
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getQuotedName() can probably be rewritten as quotedName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnInsertability() can probably be rewritten as columnInsertability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnInsertability() can probably be rewritten as columnInsertability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnUpdateability() can probably be rewritten as columnUpdateability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnUpdateability() can probably be rewritten as columnUpdateability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getConstraintColumns() can probably be rewritten as constraintColumns
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getForeignKeyName() can probably be rewritten as foreignKeyName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getIdentifierGeneratorStrategy() can probably be rewritten as identifierGeneratorStrategy
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getReferencedEntityName() can probably be rewritten as referencedEntityName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getReferencedPropertyName() can probably be rewritten as referencedPropertyName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCollectionTable() can probably be rewritten as collectionTable
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnInsertability() can probably be rewritten as columnInsertability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCacheConcurrencyStrategy() can probably be rewritten as cacheConcurrencyStrategy
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCacheRegionName() can probably be rewritten as cacheRegionName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnSpan() can probably be rewritten as columnSpan
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnUpdateability() can probably be rewritten as columnUpdateability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getElementNodeName() can probably be rewritten as elementNodeName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnInsertability() can probably be rewritten as columnInsertability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnInsertability() can probably be rewritten as columnInsertability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnUpdateability() can probably be rewritten as columnUpdateability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnUpdateability() can probably be rewritten as columnUpdateability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnSpan() can probably be rewritten as columnSpan
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnIterator() can probably be rewritten as columnIterator
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCanonicalName() can probably be rewritten as canonicalName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getCheckConstraint() can probably be rewritten as checkConstraint
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getDefaultValue() can probably be rewritten as defaultValue
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getQuotedName() can probably be rewritten as quotedName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getForeignKeyName() can probably be rewritten as foreignKeyName
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getIdentifierGeneratorStrategy() can probably be rewritten as identifierGeneratorStrategy
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getTypeParameters() can probably be rewritten as typeParameters
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnInsertability() can probably be rewritten as columnInsertability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnInsertability() can probably be rewritten as columnInsertability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnUpdateability() can probably be rewritten as columnUpdateability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnUpdateability() can probably be rewritten as columnUpdateability
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnSpan() can probably be rewritten as columnSpan
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getColumnSpan() can probably be rewritten as columnSpan
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalListMappingTests. getAssociatedClass() can probably be rewritten as associatedClass
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalOneToManyAndCircularOneToManyTests. getOtherSide() can probably be rewritten as otherSide
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalOneToManyAndCircularOneToManyTests. getOtherSide() can probably be rewritten as otherSide
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalOneToManyAndCircularOneToManyTests. getOtherSide() can probably be rewritten as otherSide
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalOneToManyAndCircularOneToManyTests. getOtherSide() can probably be rewritten as otherSide
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.BidirectionalOnetoManyWithInheritanceRelationshipManagementTests. getOtherSide() can probably be rewritten as otherSide
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.DataSourceTests. getWrappedConnection() can probably be rewritten as wrappedConnection
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.DataSourceTests. getWrappedConnection() can probably be rewritten as wrappedConnection
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.DontFlushAfterDataAccessExceptionTests. getFlushMode() can probably be rewritten as flushMode
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.DontFlushAfterDataAccessExceptionTests. getFlushMode() can probably be rewritten as flushMode
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.HibernateCriteriaBuilderTests. getClassLoader() can probably be rewritten as classLoader
[MSG]Violation in class TestAuditListener. Method parameter [event] is never referenced in the method onPostInsert of class org.codehaus.groovy.grails.orm.hibernate.TestAuditListener
[MSG]Violation in class TestAuditListener. Method parameter [event] is never referenced in the method onPostDelete of class org.codehaus.groovy.grails.orm.hibernate.TestAuditListener
[MSG]Violation in class TestAuditListener. Method parameter [event] is never referenced in the method onSaveOrUpdate of class org.codehaus.groovy.grails.orm.hibernate.TestAuditListener
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.MapMappingTests. assertTrue(!book.hasErrors()) can be simplified to assertFalse(book.hasErrors())
[SRC]assertTrue "should have inherited blank from shared cons..", !cp.blank
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.MappingDefaultsTests. assertTrue(!cp.blank) can be simplified to assertFalse(cp.blank)
[SRC]assertTrue "should not have inherited matches from [anot..", !cp.email
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.MappingDefaultsTests. assertTrue(!cp.email) can be simplified to assertFalse(cp.email)
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.MappingDefaultsTests. The test method testMappingDefaults() is being invoked explicitly from within a unit test. Tests should be isolated and not dependent on one another
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.NamedCriteriaPublication. Parentheses in the 'thisWeeksPaperbacks' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.NamingTests. The String.substring(int, int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.SavePersistentMethodTests. getEventTriggeringInterceptor() can probably be rewritten as eventTriggeringInterceptor
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.SavePersistentMethodTests. getEventTriggeringInterceptor() can probably be rewritten as eventTriggeringInterceptor
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.TablePerSubclassIdentityMappingTests. getConnection() can probably be rewritten as connection
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.TablePerSubclassWithCustomTableNameTests. getConnection() can probably be rewritten as connection
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedStringProperty() can probably be rewritten as constrainedStringProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedStringProperty() can probably be rewritten as constrainedStringProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedStringProperty() can probably be rewritten as constrainedStringProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedStringProperty() can probably be rewritten as constrainedStringProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedStringProperty() can probably be rewritten as constrainedStringProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.cfg.GrailsDomainBinderTests. getConstrainedBigDecimalProperty() can probably be rewritten as constrainedBigDecimalProperty
[SRC]boolean equals(Object x, Object y) { x == y }
[MSG]Violation in class MonetaryAmountUserType. The class org.codehaus.groovy.grails.orm.hibernate.cfg.MonetaryAmountUserType overloads the equals method, it does not override it.
[MSG]Violation in class MonetaryAmountUserType. Method parameter [owner] is never referenced in the method nullSafeGet of class org.codehaus.groovy.grails.orm.hibernate.cfg.MonetaryAmountUserType
[MSG]Violation in class MonetaryAmountUserType. Method parameter [owner] is never referenced in the method assemble of class org.codehaus.groovy.grails.orm.hibernate.cfg.MonetaryAmountUserType
[SRC]Object replace(Object original, Object target, Object ow..{ original }
[MSG]Violation in class MonetaryAmountUserType. Method parameter [target] is never referenced in the method replace of class org.codehaus.groovy.grails.orm.hibernate.cfg.MonetaryAmountUserType
[SRC]Object replace(Object original, Object target, Object ow..{ original }
[MSG]Violation in class MonetaryAmountUserType. Method parameter [owner] is never referenced in the method replace of class org.codehaus.groovy.grails.orm.hibernate.cfg.MonetaryAmountUserType
[MSG]Violation in class MyUserType. The class org.codehaus.groovy.grails.orm.hibernate.cfg.MyUserType overloads the equals method, it does not override it.
[MSG]Violation in class MyUserType. Method parameter [owner] is never referenced in the method nullSafeGet of class org.codehaus.groovy.grails.orm.hibernate.cfg.MyUserType
[MSG]Violation in class MyUserType. Method parameter [owner] is never referenced in the method assemble of class org.codehaus.groovy.grails.orm.hibernate.cfg.MyUserType
[SRC]Object replace(Object original, Object target, Object ow..{ original }
[MSG]Violation in class MyUserType. Method parameter [target] is never referenced in the method replace of class org.codehaus.groovy.grails.orm.hibernate.cfg.MyUserType
[SRC]Object replace(Object original, Object target, Object ow..{ original }
[MSG]Violation in class MyUserType. Method parameter [owner] is never referenced in the method replace of class org.codehaus.groovy.grails.orm.hibernate.cfg.MyUserType
[MSG]Violation in class ClassWithListArgBeforeValidate. Method parameter [properties] is never referenced in the method beforeValidate of class org.codehaus.groovy.grails.orm.hibernate.metaclass.ClassWithListArgBeforeValidate
[MSG]Violation in class ClassWithOverloadedBeforeValidate. Method parameter [properties] is never referenced in the method beforeValidate of class org.codehaus.groovy.grails.orm.hibernate.metaclass.ClassWithOverloadedBeforeValidate
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.support.HibernatePersistenceContextInterceptorTests. getInterceptor() can probably be rewritten as interceptor
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.support.HibernatePersistenceContextInterceptorTests. getInterceptor() can probably be rewritten as interceptor
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.support.HibernatePersistenceContextInterceptorTests. getInterceptor() can probably be rewritten as interceptor
[MSG]Violation in class org.codehaus.groovy.grails.orm.hibernate.support.HibernatePersistenceContextInterceptorTests. getInterceptor() can probably be rewritten as interceptor
[MSG]Violation in class org.codehaus.groovy.grails.plugins.scaffolding.ScaffoldingGrailsPluginTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class org.codehaus.groovy.grails.plugins.scaffolding.ScaffoldingGrailsPluginTests. getLoadedClasses() can probably be rewritten as loadedClasses
[MSG]Violation in class org.codehaus.groovy.grails.plugins.services.ServicesGrailsPluginTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class TestScaffoldingViewResolver. Method parameter [domainClass] is never referenced in the method generateViewSource of class org.codehaus.groovy.grails.scaffolding.view.TestScaffoldingViewResolver
[MSG]Violation in class org.codehaus.groovy.grails.scaffolding.view.ScaffoldingViewResolverTests. getServletContext() can probably be rewritten as servletContext
[MSG]Violation in class TestScope. Method parameter [name] is never referenced in the method registerDestructionCallback of class grails.spring.TestScope
[MSG]Violation in class TestScope. Method parameter [callback] is never referenced in the method registerDestructionCallback of class grails.spring.TestScope
[MSG]Violation in class GrailsMockCollaborator. Method parameter [str] is never referenced in the method multiMethod of class grails.test.GrailsMockCollaborator
[MSG]Violation in class GrailsMockCollaborator. Method parameter [str] is never referenced in the method multiMethod of class grails.test.GrailsMockCollaborator
[MSG]Violation in class GrailsMockCollaborator. Method parameter [map] is never referenced in the method multiMethod of class grails.test.GrailsMockCollaborator
[MSG]Violation in class GrailsMockCollaborator. Method parameter [str1] is never referenced in the method someMethod of class grails.test.GrailsMockCollaborator
[MSG]Violation in class GrailsMockCollaborator. Method parameter [args] is never referenced in the method someMethod of class grails.test.GrailsMockCollaborator
[MSG]Violation in class GrailsMockCollaborator. Method parameter [str2] is never referenced in the method someMethod of class grails.test.GrailsMockCollaborator
[MSG]Violation in class ClassWithListArgBeforeValidate. Method parameter [properties] is never referenced in the method beforeValidate of class grails.test.ClassWithListArgBeforeValidate
[MSG]Violation in class ClassWithOverloadedBeforeValidate. Method parameter [properties] is never referenced in the method beforeValidate of class grails.test.ClassWithOverloadedBeforeValidate
[MSG]The code uses '(val.size() % 2 == 1)' to check for oddness, which does not work for negative numbers. Use (val.size() & 1 == 1) or (val.size() % 2 != 0) instead
[MSG]The code uses '(val.size() % 2 == 1)' to check for oddness, which does not work for negative numbers. Use (val.size() & 1 == 1) or (val.size() % 2 != 0) instead
[MSG]Violation in class BuildSettingsTestsGrailsBuildListener. Method parameter [name] is never referenced in the method receiveGrailsBuildEvent of class grails.util.BuildSettingsTestsGrailsBuildListener
[MSG]Violation in class BuildSettingsTestsGrailsBuildListener. Method parameter [args] is never referenced in the method receiveGrailsBuildEvent of class grails.util.BuildSettingsTestsGrailsBuildListener
[SRC]assertTrue("should not be a plugin-two dir in same dir a..pp.exists())
[MSG]Violation in class grails.util.PluginBuildSettingsTests. assertTrue(!pluginTwoInSameDirAsRootApp.exists()) can be simplified to assertFalse(pluginTwoInSameDirAsRootApp.exists())
[MSG]Violation in class CodecWithMethodsCodec. Method parameter [obj] is never referenced in the method encode of class org.codehaus.groovy.grails.commons.CodecWithMethodsCodec
[MSG]Violation in class CodecWithMethodsCodec. Method parameter [obj] is never referenced in the method decode of class org.codehaus.groovy.grails.commons.CodecWithMethodsCodec
[MSG]Violation in class org.codehaus.groovy.grails.commons.DefaultGrailsDomainClassTests. getPersistentProperties() can probably be rewritten as persistentProperties
[MSG]Violation in class org.codehaus.groovy.grails.commons.GrailsPluginManagerTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class org.codehaus.groovy.grails.commons.GrailsPluginManagerTests. getApplicationContext() can probably be rewritten as applicationContext
[SRC]def obj = new PropertyMapTest(name:"Homer", age:45)
[MSG]new PropertyMapTest([name:Homer, age:45]) creates an instance of a test case. Test cases should not be coupled. Move this method to a helper object
[SRC]def map = new LazyMetaPropertyMap(new PropertyMapTest(na..er:"stuff"))
[MSG]new PropertyMapTest([name:Bart, age:11, other:stuff]) creates an instance of a test case. Test cases should not be coupled. Move this method to a helper object
[SRC]def map = new LazyMetaPropertyMap(new PropertyMapTest(na..r", age:45))
[MSG]new PropertyMapTest([name:Homer, age:45]) creates an instance of a test case. Test cases should not be coupled. Move this method to a helper object
[SRC]def map = new LazyMetaPropertyMap(new PropertyMapTest(na..r", age:45))
[MSG]new PropertyMapTest([name:Homer, age:45]) creates an instance of a test case. Test cases should not be coupled. Move this method to a helper object
[SRC]def map = new LazyMetaPropertyMap(new PropertyMapTest(na..t", age:11))
[MSG]new PropertyMapTest([name:Bart, age:11]) creates an instance of a test case. Test cases should not be coupled. Move this method to a helper object
[SRC]def map = new LazyMetaPropertyMap(new PropertyMapTest(na..t", age:11))
[MSG]new PropertyMapTest([name:Bart, age:11]) creates an instance of a test case. Test cases should not be coupled. Move this method to a helper object
[SRC]def map = new LazyMetaPropertyMap(new PropertyMapTest(na..t", age:11))
[MSG]new PropertyMapTest([name:Bart, age:11]) creates an instance of a test case. Test cases should not be coupled. Move this method to a helper object
[SRC]assert e == gcl.getCompilationError() : "should have sto..ation error"
[MSG]Violation in class org.codehaus.groovy.grails.compiler.GrailsClassLoaderTests. getCompilationError() can probably be rewritten as compilationError
[SRC]assert !gcl.getCompilationError() : "shouldn't have any ..tion errors"
[MSG]Violation in class org.codehaus.groovy.grails.compiler.GrailsClassLoaderTests. getCompilationError() can probably be rewritten as compilationError
[MSG]Violation in class TestPluginAwareResourceBundleMessageSource. Method parameter [pluginName] is never referenced in the method getPluginBundles of class org.codehaus.groovy.grails.context.support.TestPluginAwareResourceBundleMessageSource
[MSG]Violation in class org.codehaus.groovy.grails.context.support.PluginAwareResourceBundleMessageSourceTests. getCurrent() can probably be rewritten as current
[MSG]Violation in class org.codehaus.groovy.grails.context.support.PluginAwareResourceBundleMessageSourceTests. getCurrent() can probably be rewritten as current
[MSG]Violation in class org.codehaus.groovy.grails.plugins.CoreGrailsPluginTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class org.codehaus.groovy.grails.plugins.CoreGrailsPluginTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class org.codehaus.groovy.grails.plugins.CoreGrailsPluginTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class org.codehaus.groovy.grails.plugins.CoreGrailsPluginTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class AlwaysInjector. Method parameter [url] is never referenced in the method shouldInject of class org.codehaus.groovy.grails.plugins.AlwaysInjector
[MSG]Violation in class AlwaysInjector. Method parameter [classNode] is never referenced in the method isDomainClass of class org.codehaus.groovy.grails.plugins.AlwaysInjector
[MSG]Violation in class AlwaysInjector. Method parameter [sourceNode] is never referenced in the method isDomainClass of class org.codehaus.groovy.grails.plugins.AlwaysInjector
[MSG]Violation in class AlwaysInjector. Method parameter [classNode] is never referenced in the method shouldInjectClass of class org.codehaus.groovy.grails.plugins.AlwaysInjector
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtilsTests. getPluginDirectories() can probably be rewritten as pluginDirectories
[MSG]Violation in class org.codehaus.groovy.grails.plugins.GrailsPluginUtilsTests. getImplicitPluginDirectories() can probably be rewritten as implicitPluginDirectories
[SRC]Resource createRelative(String relativePath) { new ByteA..xml.bytes) }
[MSG]Violation in class PluginDescriptorReaderTests$1. Method parameter [relativePath] is never referenced in the method createRelative of class org.codehaus.groovy.grails.plugins.PluginDescriptorReaderTests$1
[MSG]Violation in class MockPluginInfo. Method parameter [pluginDir] is never referenced in the method parseMetadata of class org.codehaus.groovy.grails.plugins.MockPluginInfo
[MSG]Violation in class org.codehaus.groovy.grails.plugins.i18n.I18nGrailsPluginTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class TestPluginPublisher. Method parameter [pluginName] is never referenced in the method getPluginMetadata of class org.codehaus.groovy.grails.plugins.publishing.TestPluginPublisher
[MSG]Violation in class TestPluginPublisher. Method parameter [pluginsListFile] is never referenced in the method parsePluginList of class org.codehaus.groovy.grails.plugins.publishing.TestPluginPublisher
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.ControllersGrailsPluginTests. getPropertyValues() can probably be rewritten as propertyValues
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.ControllersGrailsPluginTests. getPropertyValues() can probably be rewritten as propertyValues
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.ControllersGrailsPluginTests. getPropertyValues() can probably be rewritten as propertyValues
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.ServletsGrailsPluginTests. getMetaClassRegistry() can probably be rewritten as metaClassRegistry
[MSG]Violation in class org.codehaus.groovy.grails.plugins.web.ServletsGrailsPluginTests. getMetaClassRegistry() can probably be rewritten as metaClassRegistry
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getDependencyRevisionId() can probably be rewritten as dependencyRevisionId
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getDependencyRevisionId() can probably be rewritten as dependencyRevisionId
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getDependencyRevisionId() can probably be rewritten as dependencyRevisionId
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getModuleConfigurations() can probably be rewritten as moduleConfigurations
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getApplicationDependencyDescriptors() can probably be rewritten as applicationDependencyDescriptors
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getCurrentGrailsVersion() can probably be rewritten as currentGrailsVersion
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getCurrentGrailsVersion() can probably be rewritten as currentGrailsVersion
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getDependencyDescriptors() can probably be rewritten as dependencyDescriptors
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getDependencyDescriptors() can probably be rewritten as dependencyDescriptors
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getPluginDependencyDescriptors() can probably be rewritten as pluginDependencyDescriptors
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getPluginDependencyDescriptors() can probably be rewritten as pluginDependencyDescriptors
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getDependencyDescriptors() can probably be rewritten as dependencyDescriptors
[MSG]Violation in class org.codehaus.groovy.grails.resolve.IvyDependencyManagerTests. getDependencyDescriptors() can probably be rewritten as dependencyDescriptors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrorCount() can probably be rewritten as errorCount
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getRejectedValue() can probably be rewritten as rejectedValue
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrorCount() can probably be rewritten as errorCount
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getRejectedValue() can probably be rewritten as rejectedValue
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrorCount() can probably be rewritten as errorCount
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getRejectedValue() can probably be rewritten as rejectedValue
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrorCount() can probably be rewritten as errorCount
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getRejectedValue() can probably be rewritten as rejectedValue
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrorCount() can probably be rewritten as errorCount
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrorCount() can probably be rewritten as errorCount
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getRejectedValue() can probably be rewritten as rejectedValue
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getRejectedValue() can probably be rewritten as rejectedValue
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getParameter() can probably be rewritten as parameter
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrorCount() can probably be rewritten as errorCount
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrorCount() can probably be rewritten as errorCount
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getRejectedValue() can probably be rewritten as rejectedValue
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getRejectedValue() can probably be rewritten as rejectedValue
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getErrors() can probably be rewritten as errors
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class org.codehaus.groovy.grails.validation.ConstrainedPropertyBuilderForCommandsTests. getConstraints() can probably be rewritten as constraints
[MSG]Violation in class TestConstraint. Method parameter [propertyValue] is never referenced in the method processValidate of class org.codehaus.groovy.grails.validation.TestConstraint
[MSG]Violation in class TestConstraint. Method parameter [type] is never referenced in the method supports of class org.codehaus.groovy.grails.validation.TestConstraint
[MSG]Violation in class DummyViewResolver. Method parameter [locale] is never referenced in the method resolveViewName of class org.codehaus.groovy.grails.web.errors.DummyViewResolver
[MSG]Violation in class org.codehaus.groovy.grails.web.errors.GrailsExceptionResolverTests. getForwardedUrl() can probably be rewritten as forwardedUrl
[MSG]Violation in class org.codehaus.groovy.grails.web.i18n.ParamsAwareLocaleChangeInterceptorTests. getCurrentRequest() can probably be rewritten as currentRequest
[MSG]Violation in class org.codehaus.groovy.grails.web.i18n.ParamsAwareLocaleChangeInterceptorTests. getCurrentResponse() can probably be rewritten as currentResponse
[MSG]Violation in class org.codehaus.groovy.grails.web.i18n.ParamsAwareLocaleChangeInterceptorTests. getLanguage() can probably be rewritten as language
[MSG]Violation in class org.codehaus.groovy.grails.web.i18n.ParamsAwareLocaleChangeInterceptorTests. getCurrentRequest() can probably be rewritten as currentRequest
[MSG]Violation in class org.codehaus.groovy.grails.web.i18n.ParamsAwareLocaleChangeInterceptorTests. getCurrentResponse() can probably be rewritten as currentResponse
[MSG]Violation in class org.codehaus.groovy.grails.web.i18n.ParamsAwareLocaleChangeInterceptorTests. getLanguage() can probably be rewritten as language
[MSG]Violation in class org.codehaus.groovy.grails.web.i18n.ParamsAwareLocaleChangeInterceptorTests. getCurrentRequest() can probably be rewritten as currentRequest
[MSG]Violation in class org.codehaus.groovy.grails.web.i18n.ParamsAwareLocaleChangeInterceptorTests. getCurrentResponse() can probably be rewritten as currentResponse
[MSG]Violation in class org.codehaus.groovy.grails.web.i18n.ParamsAwareLocaleChangeInterceptorTests. getLanguage() can probably be rewritten as language
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'runTest' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'runTest' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'runTest' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'runTest' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'runTest' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'runTest' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'runTest' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'each' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'runTest' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.BindDataMethodTests. Parentheses in the 'runTest' method call are unnecessary and can be removed.
[MSG]The expression '(WebMetaUtils.isCommandObjectAction(fresh.index) == false)' can be simplified to '!WebMetaUtils.isCommandObjectAction(fresh.index)'
[MSG]Violation in class org.codehaus.groovy.grails.web.servlet.mvc.ControllersDynamicMethodsTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class DummyFactory. Method parameter [path] is never referenced in the method isPathExcluded of class org.codehaus.groovy.grails.web.sitemesh.DummyFactory
[MSG]Violation in class DummyFactory. Method parameter [contentType] is never referenced in the method shouldParsePage of class org.codehaus.groovy.grails.web.sitemesh.DummyFactory
[MSG]Violation in class DummyFactory. Method parameter [contentType] is never referenced in the method getPageParser of class org.codehaus.groovy.grails.web.sitemesh.DummyFactory
[MSG]Violation in class ClassEditorGrailsPlugin. Method parameter [ctx] is never referenced in the method withApplicationContext of class ClassEditorGrailsPlugin
[MSG]Violation in class MultipleMappingsTestCase. Method parameter [controller] is never referenced in the method assertView of class grails.test.MultipleMappingsTestCase
[MSG]Violation in class MultipleMappingsTestCase. Method parameter [view] is never referenced in the method assertView of class grails.test.MultipleMappingsTestCase
[MSG]Violation in class MultipleMappingsTestCase. Method parameter [url] is never referenced in the method assertView of class grails.test.MultipleMappingsTestCase
[MSG]Violation in class MockUrlMapping. Method parameter [parameterValues] is never referenced in the method createURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [parameterValues] is never referenced in the method createURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [parameterValues] is never referenced in the method createURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [controller] is never referenced in the method createRelativeURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [action] is never referenced in the method createRelativeURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [parameterValues] is never referenced in the method createRelativeURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [encoding] is never referenced in the method createRelativeURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [controller] is never referenced in the method createRelativeURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [action] is never referenced in the method createRelativeURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [parameterValues] is never referenced in the method createRelativeURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [encoding] is never referenced in the method createRelativeURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [fragment] is never referenced in the method createRelativeURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [parameterValues] is never referenced in the method createURL of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [parameterValues] is never referenced in the method setParameterValues of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [shouldParse] is never referenced in the method setParseRequest of class grails.test.MockUrlMapping
[MSG]Violation in class MockUrlMapping. Method parameter [name] is never referenced in the method hasRuntimeVariable of class grails.test.MockUrlMapping
[MSG]Violation in class org.codehaus.groovy.grails.plugins.webflow.MockWebFlowGrailsPlugin. getGrailsVersion() can probably be rewritten as grailsVersion
[SRC]def map = new DataBindingLazyMetaPropertyMap(new Propert..er:"stuff"))
[MSG]new PropertyMapTest([name:Bart, age:11, other:stuff]) creates an instance of a test case. Test cases should not be coupled. Move this method to a helper object
[MSG]Violation in class org.codehaus.groovy.grails.web.mapping.DoubleWildcardUrlMappingTests. getControllerName() can probably be rewritten as controllerName
[MSG]Violation in class org.codehaus.groovy.grails.web.mapping.ResponseCodeUrlMappingTests. getControllerName() can probably be rewritten as controllerName
[MSG]Violation in class org.codehaus.groovy.grails.web.mapping.ResponseCodeUrlMappingTests. getControllerName() can probably be rewritten as controllerName
[MSG]Violation in class org.codehaus.groovy.grails.web.mapping.UrlMappingWithCustomValidatorTests. The def keyword is unneeded when a field type is specified
[SRC]def rootLoader = new RootLoader([] as URL[], Thread.curr..assLoader())
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPageWithJSPTagsTests. getContextClassLoader() can probably be rewritten as contextClassLoader
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPageWithJSPTagsTests. getCurrentRequest() can probably be rewritten as currentRequest
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesPageContextTests. getServletConfig() can probably be rewritten as servletConfig
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesPageContextTests. getServletContext() can probably be rewritten as servletContext
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.IterativeJspTagTests. getCurrentRequest() can probably be rewritten as currentRequest
[SRC]def rootLoader = new RootLoader([] as URL[], Thread.curr..assLoader())
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.IterativeJspTagTests. getContextClassLoader() can probably be rewritten as contextClassLoader
[SRC]def rootLoader = new RootLoader([] as URL[], Thread.curr..assLoader())
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.MockRootLoaderTagLibraryResolver. getContextClassLoader() can probably be rewritten as contextClassLoader
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.SimpleJspTagTests. getCurrentRequest() can probably be rewritten as currentRequest
[SRC]new RootLoader([] as URL[], Thread.currentThread().getCo..assLoader())
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.MockWebXmlTagLibraryResolver. getContextClassLoader() can probably be rewritten as contextClassLoader
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.MockWebXmlTagLibraryResolver. getInputStream() can probably be rewritten as inputStream
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.WebXmlTagLibraryReaderTests. getXMLReader() can probably be rewritten as XMLReader
[SRC]assertEquals("for( "+tag.getForeachRenamedIt()+" in eval...toString())
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.GroovyFindAllTagTests. getForeachRenamedIt() can probably be rewritten as foreachRenamedIt
[SRC]assertEquals("for( "+tag.getForeachRenamedIt()+" in eval...toString())
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.GroovyFindAllTagTests. getForeachRenamedIt() can probably be rewritten as foreachRenamedIt
[MSG]Violation in class JavascriptTagLibTests. Method parameter [tag] is never referenced in the method setupPluginController of class org.codehaus.groovy.grails.web.taglib.JavascriptTagLibTests
[MSG]Violation in class TestProvider. Method parameter [taglib] is never referenced in the method doRemoteFunction of class org.codehaus.groovy.grails.web.taglib.TestProvider
[MSG]Violation in class TestProvider. Method parameter [attrs] is never referenced in the method doRemoteFunction of class org.codehaus.groovy.grails.web.taglib.TestProvider
[MSG]Violation in class TestProvider. Method parameter [attrs] is never referenced in the method prepareAjaxForm of class org.codehaus.groovy.grails.web.taglib.TestProvider
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.PropertyEditorTests. The call to collect could probably be rewritten as a spread expression: obj.tags*.name
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.SelectTagTests. Parentheses in the 'each' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.SelectTagTests. Parentheses in the 'each' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.SelectTagTests. Parentheses in the 'each' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.SelectTagTests. Parentheses in the 'each' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.SelectTagTests. Parentheses in the 'each' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.SelectTagTests. Parentheses in the 'each' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.web.taglib.SelectTagTests. Parentheses in the 'each' method call are unnecessary and can be removed.
[MSG]Violation in class org.codehaus.groovy.grails.webflow.FlowRedirectTests. getExternalRedirectUrl() can probably be rewritten as externalRedirectUrl
[MSG]Violation in class org.codehaus.groovy.grails.webflow.FlowRedirectTests. getExternalRedirectUrl() can probably be rewritten as externalRedirectUrl
[MSG]Violation in class org.codehaus.groovy.grails.webflow.FlowRedirectTests. getExternalRedirectUrl() can probably be rewritten as externalRedirectUrl
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilderDynamicTransitionTests. getStartState() can probably be rewritten as startState
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilderExecutionTests. getFlowScope() can probably be rewritten as flowScope
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilderSubFlowExecutionTests. getFlowDefinition() can probably be rewritten as flowDefinition
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilderTests. getExpressionParser() can probably be rewritten as expressionParser
[SRC]def flow = new FlowBuilder("myFlow",getFlowBuilderServic..pl()).flow {
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilderTests. getFlowBuilderServices() can probably be rewritten as flowBuilderServices
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.RuntimeRedirectActionTests. getFlowScope() can probably be rewritten as flowScope
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.RuntimeRedirectActionTests. getExternalRedirectUrl() can probably be rewritten as externalRedirectUrl
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.RuntimeRedirectActionTests. getFlowScope() can probably be rewritten as flowScope
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.RuntimeRedirectActionTests. getExternalRedirectUrl() can probably be rewritten as externalRedirectUrl
[MSG]Violation in class org.codehaus.groovy.grails.webflow.support.AbstractGrailsTagAwareFlowExecutionTests. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class org.codehaus.groovy.grails.webflow.support.AbstractGrailsTagAwareFlowExecutionTests. getExpressionParser() can probably be rewritten as expressionParser
[SRC]FlowBuilder builder = new FlowBuilder(flowId, flowClosur..nRegistry())
[MSG]Violation in class org.codehaus.groovy.grails.webflow.support.AbstractGrailsTagAwareFlowExecutionTests. getFlowDefinitionRegistry() can probably be rewritten as flowDefinitionRegistry
[SRC]FlowAssembler assembler = new FlowAssembler(builder, bui..erContext())
[MSG]Violation in class org.codehaus.groovy.grails.webflow.support.AbstractGrailsTagAwareFlowExecutionTests. getFlowBuilderContext() can probably be rewritten as flowBuilderContext
[MSG]Violation in class org.codehaus.groovy.grails.webflow.support.AbstractGrailsTagAwareFlowExecutionTests. getFlowDefinitionRegistry() can probably be rewritten as flowDefinitionRegistry
[MSG]Violation in class org.codehaus.groovy.grails.webflow.support.AbstractGrailsTagAwareFlowExecutionTests. getFlowDefinitionRegistry() can probably be rewritten as flowDefinitionRegistry
[MSG]Violation in class org.codehaus.groovy.grails.webflow.support.AbstractGrailsTagAwareFlowExecutionTests. getFlowId() can probably be rewritten as flowId
[MSG]Violation in class org.codehaus.groovy.grails.webflow.support.AbstractGrailsTagAwareFlowExecutionTests. getFlowClosure() can probably be rewritten as flowClosure
[MSG]Violation in class org.codehaus.groovy.grails.plugins.testing.AbstractGrailsMockHttpServletResponse. getCurrentRequest() can probably be rewritten as currentRequest
[MSG]Violation in class org.codehaus.groovy.grails.plugins.testing.AbstractGrailsMockHttpServletResponse. getWriter() can probably be rewritten as writer
[MSG]Violation in class org.codehaus.groovy.grails.plugins.testing.AbstractGrailsMockHttpServletResponse. getRedirectedUrl() can probably be rewritten as redirectedUrl
[MSG]Violation in class org.codehaus.groovy.grails.plugins.testing.AbstractGrailsMockHttpServletResponse. getStatus() can probably be rewritten as status
[MSG]Violation in class org.codehaus.groovy.grails.plugins.testing.AbstractGrailsMockHttpServletResponse. getRedirectedUrl() can probably be rewritten as redirectedUrl
[MSG]Violation in class MockAsyncContext. Method parameter [context] is never referenced in the method dispatch of class org.codehaus.groovy.grails.plugins.testing.MockAsyncContext
[MSG]Violation in class org.codehaus.groovy.grails.test.GrailsTestTargetPattern. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.test.GrailsTestTargetPattern. The String.substring(int, int) method can be replaced with the subscript operator
[MSG]Violation in class GrailsTestEventConsoleReporter. Method parameter [failure] is never referenced in the method doTestFailure of class org.codehaus.groovy.grails.test.event.GrailsTestEventConsoleReporter
[MSG]Violation in class GrailsTestEventConsoleReporter. Method parameter [isError] is never referenced in the method doTestFailure of class org.codehaus.groovy.grails.test.event.GrailsTestEventConsoleReporter
[MSG]Violation in class GrailsTestEventConsoleReporter. Method parameter [name] is never referenced in the method doTestCaseEnd of class org.codehaus.groovy.grails.test.event.GrailsTestEventConsoleReporter
[MSG]Violation in class GrailsTestEventConsoleReporter. Method parameter [err] is never referenced in the method doTestCaseEnd of class org.codehaus.groovy.grails.test.event.GrailsTestEventConsoleReporter
[MSG]Violation in class org.codehaus.groovy.grails.test.junit4.JUnit4GrailsTestType. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class SuiteRunListener. Method parameter [description] is never referenced in the method testRunStarted of class org.codehaus.groovy.grails.test.junit4.listener.SuiteRunListener
[MSG]Violation in class SuiteRunListener. Method parameter [result] is never referenced in the method testRunFinished of class org.codehaus.groovy.grails.test.junit4.listener.SuiteRunListener
[MSG]Violation in class SuiteRunListener. Method parameter [description] is never referenced in the method testIgnored of class org.codehaus.groovy.grails.test.junit4.listener.SuiteRunListener
[MSG]Violation in class org.codehaus.groovy.grails.test.junit4.listener.SuiteRunListener. getPerTestRunListener() can probably be rewritten as perTestRunListener
[MSG]Violation in class GrailsTestInterceptor. Method parameter [body] is never referenced in the method initRequestEnvironmentIfNecessary of class org.codehaus.groovy.grails.test.support.GrailsTestInterceptor
[MSG]Violation in class org.codehaus.groovy.grails.test.support.GrailsTestTypeSupport. getTestClassLoader() can probably be rewritten as testClassLoader
[MSG]Violation in class org.codehaus.groovy.grails.test.support.GrailsTestTypeSupport. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.test.support.GrailsTestTypeSupport. getTestClassLoader() can probably be rewritten as testClassLoader
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesPageContext21. getDefaultFactory() can probably be rewritten as defaultFactory
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesPageContext21. getDefaultFactory() can probably be rewritten as defaultFactory
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesPageContext21. getServletContext() can probably be rewritten as servletContext
[MSG]Violation in class PageRenderer$PageRenderRequest. Method parameter [name] is never referenced in the method getDateHeader of class grails.gsp.PageRenderer$PageRenderRequest
[MSG]Violation in class PageRenderer$PageRenderRequest. Method parameter [name] is never referenced in the method getHeader of class grails.gsp.PageRenderer$PageRenderRequest
[MSG]Violation in class PageRenderer$PageRenderRequest. Method parameter [name] is never referenced in the method getHeaders of class grails.gsp.PageRenderer$PageRenderRequest
[MSG]Violation in class PageRenderer$PageRenderRequest. Method parameter [name] is never referenced in the method getIntHeader of class grails.gsp.PageRenderer$PageRenderRequest
[MSG]Violation in class PageRenderer$PageRenderRequest. Method parameter [role] is never referenced in the method isUserInRole of class grails.gsp.PageRenderer$PageRenderRequest
[SRC]HttpSession getSession(boolean create) { throw new Unsup..erations") }
[MSG]Violation in class PageRenderer$PageRenderRequest. Method parameter [create] is never referenced in the method getSession of class grails.gsp.PageRenderer$PageRenderRequest
[MSG]Violation in class PageRenderer$PageRenderRequest. Method parameter [name] is never referenced in the method getParameterValues of class grails.gsp.PageRenderer$PageRenderRequest
[MSG]Violation in class PageRenderer$PageRenderRequest. Method parameter [path] is never referenced in the method getRequestDispatcher of class grails.gsp.PageRenderer$PageRenderRequest
[MSG]Violation in class PageRenderer$PageRenderRequest. Method parameter [path] is never referenced in the method getRealPath of class grails.gsp.PageRenderer$PageRenderRequest
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [cookie] is never referenced in the method addCookie of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [name] is never referenced in the method containsHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [sc] is never referenced in the method sendError of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [msg] is never referenced in the method sendError of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [sc] is never referenced in the method sendError of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [location] is never referenced in the method sendRedirect of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [name] is never referenced in the method setDateHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [date] is never referenced in the method setDateHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [name] is never referenced in the method addDateHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [date] is never referenced in the method addDateHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [name] is never referenced in the method setHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [value] is never referenced in the method setHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [name] is never referenced in the method addHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [value] is never referenced in the method addHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [name] is never referenced in the method setIntHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [value] is never referenced in the method setIntHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [name] is never referenced in the method addIntHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [value] is never referenced in the method addIntHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [sc] is never referenced in the method setStatus of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [sc] is never referenced in the method setStatus of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [sm] is never referenced in the method setStatus of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [name] is never referenced in the method getHeader of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [name] is never referenced in the method getHeaders of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class PageRenderer$PageRenderResponse. Method parameter [len] is never referenced in the method setContentLength of class grails.gsp.PageRenderer$PageRenderResponse
[MSG]Violation in class GroovyPagesJspFactory. Method parameter [servlet] is never referenced in the method getPageContext of class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesJspFactory
[MSG]Violation in class GroovyPagesJspFactory. Method parameter [servletRequest] is never referenced in the method getPageContext of class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesJspFactory
[MSG]Violation in class GroovyPagesJspFactory. Method parameter [servletResponse] is never referenced in the method getPageContext of class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesJspFactory
[MSG]Violation in class GroovyPagesJspFactory. Method parameter [s] is never referenced in the method getPageContext of class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesJspFactory
[MSG]Violation in class GroovyPagesJspFactory. Method parameter [b] is never referenced in the method getPageContext of class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesJspFactory
[MSG]Violation in class GroovyPagesJspFactory. Method parameter [i] is never referenced in the method getPageContext of class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesJspFactory
[MSG]Violation in class GroovyPagesJspFactory. Method parameter [b1] is never referenced in the method getPageContext of class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesJspFactory
[MSG]Violation in class GroovyPagesJspFactory. Method parameter [pageContext] is never referenced in the method releasePageContext of class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesJspFactory
[SRC]return { getSpecificationVersion() } as JspEngineInfo
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.GroovyPagesJspFactory. getSpecificationVersion() can probably be rewritten as specificationVersion
[MSG]Violation in class JspTagImpl. Method parameter [attributes] is never referenced in the method handleSimpleTag of class org.codehaus.groovy.grails.web.pages.ext.jsp.JspTagImpl
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.PageContextFactory. getContextClassLoader() can probably be rewritten as contextClassLoader
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.PageContextFactory. getCurrentRequest() can probably be rewritten as currentRequest
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.PageContextFactory. getServletContext() can probably be rewritten as servletContext
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.TagLibraryResolver. getJarsFromServletContext() can probably be rewritten as jarsFromServletContext
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.TagLibraryResolver. getWebXmlFromServletContext() can probably be rewritten as webXmlFromServletContext
[MSG]Violation in class org.codehaus.groovy.grails.web.pages.ext.jsp.TagLibraryResolver. getJarsFromServletContext() can probably be rewritten as jarsFromServletContext
[MSG]Violation in class TldReader. Method parameter [nsuri] is never referenced in the method startElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.TldReader
[MSG]Violation in class TldReader. Method parameter [localName] is never referenced in the method startElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.TldReader
[MSG]Violation in class TldReader. Method parameter [attributes] is never referenced in the method startElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.TldReader
[MSG]Violation in class TldReader. Method parameter [nsuri] is never referenced in the method endElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.TldReader
[MSG]Violation in class TldReader. Method parameter [localName] is never referenced in the method endElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.TldReader
[MSG]Violation in class WebXmlTagLibraryReader. Method parameter [ns] is never referenced in the method startElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.WebXmlTagLibraryReader
[MSG]Violation in class WebXmlTagLibraryReader. Method parameter [localName] is never referenced in the method startElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.WebXmlTagLibraryReader
[MSG]Violation in class WebXmlTagLibraryReader. Method parameter [attributes] is never referenced in the method startElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.WebXmlTagLibraryReader
[MSG]Violation in class WebXmlTagLibraryReader. Method parameter [ns] is never referenced in the method endElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.WebXmlTagLibraryReader
[MSG]Violation in class WebXmlTagLibraryReader. Method parameter [localName] is never referenced in the method endElement of class org.codehaus.groovy.grails.web.pages.ext.jsp.WebXmlTagLibraryReader
[MSG]The org.codehaus.groovy.grails.webflow.persistence.SessionAwareHibernateFlowExecutionListener class was explicitly imported, so specifying the package name is not necessary
[MSG]The org.codehaus.groovy.grails.webflow.persistence.SessionAwareHibernateFlowExecutionListener class was explicitly imported, so specifying the package name is not necessary
[MSG]The org.springframework.webflow.execution.factory.StaticFlowExecutionListenerLoader class was explicitly imported, so specifying the package name is not necessary
[MSG]The org.springframework.webflow.execution.factory.StaticFlowExecutionListenerLoader class was explicitly imported, so specifying the package name is not necessary
[MSG]The org.codehaus.groovy.grails.webflow.persistence.FlowAwareCurrentSessionContext class was explicitly imported, so specifying the package name is not necessary
[MSG]The org.codehaus.groovy.grails.webflow.persistence.FlowAwareCurrentSessionContext class was explicitly imported, so specifying the package name is not necessary
[SRC]def assembler = new FlowAssembler(builder, builder.getFl..erContext())
[MSG]Violation in class org.codehaus.groovy.grails.webflow.WebFlowPluginSupport. getFlowBuilderContext() can probably be rewritten as flowBuilderContext
[SRC]FlowAssembler flowAssembler = new FlowAssembler(builder,..erContext())
[MSG]Violation in class org.codehaus.groovy.grails.webflow.WebFlowPluginSupport. getFlowBuilderContext() can probably be rewritten as flowBuilderContext
[MSG]Violation in class org.codehaus.groovy.grails.webflow.context.servlet.GrailsFlowUrlHandler. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.webflow.context.servlet.GrailsFlowUrlHandler. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.AbstractDelegate. The def keyword is unneeded when a variable is declared with a type
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.AbstractDelegate. getApplicationContext() can probably be rewritten as applicationContext
[MSG]Violation in class KeyExpression. Method parameter [context] is never referenced in the method setValue of class org.codehaus.groovy.grails.webflow.engine.builder.KeyExpression
[MSG]Violation in class KeyExpression. Method parameter [value] is never referenced in the method setValue of class org.codehaus.groovy.grails.webflow.engine.builder.KeyExpression
[MSG]Violation in class KeyExpression. Method parameter [context] is never referenced in the method getValueType of class org.codehaus.groovy.grails.webflow.engine.builder.KeyExpression
[MSG]Violation in class ClosureExpression. Method parameter [context] is never referenced in the method setValue of class org.codehaus.groovy.grails.webflow.engine.builder.ClosureExpression
[MSG]Violation in class ClosureExpression. Method parameter [value] is never referenced in the method setValue of class org.codehaus.groovy.grails.webflow.engine.builder.ClosureExpression
[MSG]Violation in class ClosureExpression. Method parameter [context] is never referenced in the method getValueType of class org.codehaus.groovy.grails.webflow.engine.builder.ClosureExpression
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.ClosureInvokingAction. getPropertyName() can probably be rewritten as propertyName
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilder. getMetaClassRegistry() can probably be rewritten as metaClassRegistry
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilder. getFlowArtifactFactory() can probably be rewritten as flowArtifactFactory
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilder. getExceptionHandlerSet() can probably be rewritten as exceptionHandlerSet
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilder. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilder. getViewFactoryCreator() can probably be rewritten as viewFactoryCreator
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilder. getExpressionParser() can probably be rewritten as expressionParser
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.FlowBuilder. getConversionService() can probably be rewritten as conversionService
[MSG]Violation in class GrailsSubflowAttributeMapper. Method parameter [output] is never referenced in the method mapSubflowOutput of class org.codehaus.groovy.grails.webflow.engine.builder.GrailsSubflowAttributeMapper
[MSG]Violation in class GrailsSubflowAttributeMapper. Method parameter [context] is never referenced in the method mapSubflowOutput of class org.codehaus.groovy.grails.webflow.engine.builder.GrailsSubflowAttributeMapper
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.RuntimeRedirectAction. getExternalContext() can probably be rewritten as externalContext
[MSG]Violation in class org.codehaus.groovy.grails.webflow.engine.builder.UriRedirectAction. getExternalContext() can probably be rewritten as externalContext
[SRC]GrailsResourceLoaderHolder.resourceLoader = new GrailsRe..vironment())
[MSG]Violation in class None. getArtefactResourcesForCurrentEnvironment() can probably be rewritten as artefactResourcesForCurrentEnvironment
Rule Descriptions
#
Rule Name
Description
1
AddEmptyString
Finds empty string literals which are being added. This is an inefficient way to convert any type to a String.
2
AssertWithinFinallyBlock
Checks for assert statements within a finally block. An assert can throw an exception, hiding the original exception, if there is one.
3
AssignmentInConditional
An assignment operator (=) was used in a conditional test. This is usually a typo, and the comparison operator (==) was intended.
4
BigDecimalInstantiation
Checks for calls to the BigDecimal constructors that take a double parameter, which may result in an unexpected BigDecimal value.
5
BitwiseOperatorInConditional
Checks for bitwise operations in conditionals, if you need to do a bitwise operation then it is best practive to extract a temp variable.
6
BooleanGetBoolean
This rule catches usages of java.lang.Boolean.getBoolean(String) which reads a boolean from the System properties. It is often mistakenly used to attempt to read user input or parse a String into a boolean. It is a poor piece of API to use; replace it with System.properties['prop'].
7
BrokenNullCheck
Looks for faulty checks for null that can cause a NullPointerException.
8
BrokenOddnessCheck
The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check for oddness, consider using x & 1 == 1, or x % 2 != 0.
9
BusyWait
Busy waiting (forcing a Thread.sleep() while waiting on a condition) should be avoided. Prefer using the gate and barrier objects in the java.util.concurrent package.
10
ChainedTest
A test method that invokes another test method is a chained test; the methods are dependent on one another. Tests should be isolated, and not be dependent on one another.
11
ClassForName
Using Class.forName(...) is a common way to add dynamic behavior to a system. However, using this method can cause resource leaks because the classes can be pinned in memory for long periods of time.
12
ComparisonOfTwoConstants
Checks for expressions where a comparison operator or equals() or compareTo() is used to compare two constants to each other or two literals that contain only constant values., e.g.: 23 == 67, Boolean.FALSE != false, 0.17 <= 0.99, "abc" > "ddd", [a:1] <=> [a:2], [1,2].equals([3,4]) or [a:false, b:true].compareTo(['a':34.5, b:Boolean.TRUE].
13
ComparisonWithSelf
Checks for expressions where a comparison operator or equals() or compareTo() is used to compare a variable to itself, e.g.: x == x, x != x, x <=> x, x < x, x =>= x, x.equals(x) or x.compareTo(x), where x is a variable.
14
ConsecutiveLiteralAppends
Violations occur when method calls to append(Object) are chained together with literals as parameters. The chained calls can be joined into one invocation.
15
ConsecutiveStringConcatenation
Catches concatenation of two string literals on the same line. These can safely by joined.
16
ConstantAssertExpression
Checks for assert statements where the assert boolean condition expression is a constant or literal value.
17
ConstantIfExpression
Checks for if statements with a constant value for the if expression, such as true, false, null, or a literal constant value.
18
ConstantTernaryExpression
Checks for ternary expressions with a constant value for the boolean expression, such as true, false, null, or a literal constant value.
19
CoupledTestCase
This rule finds test cases that are coupled to other test cases, either by invoking static methods on another test case or by creating instances of another test case. If you require shared logic in test cases then extract that logic to a new class where it can properly be reused.
20
CyclomaticComplexity
Checks the cyclomatic complexity for methods/classes.A method (or "closure field") with a cyclomatic complexity value greater than the maxMethodComplexity property (20) causes a violation. Likewise, a class that has an (average method) cyclomatic complexityvalue greater than the maxClassAverageMethodComplexity property (20) causes a violation.
21
DeadCode
Dead code appears after a return statement or an exception is thrown. If code appears after one of these statements then it will never be executed and can be safely deleted.
22
DoubleCheckedLocking
This rule detects double checked locking, where a 'lock hint' is tested for null before initializing an object within a synchronized block. Double checked locking does not guarantee correctness and is an anti-pattern.
23
DoubleNegative
There is no point in using a double negative, it is always positive. For instance !!x can always be simplified to x. And !(!x) can as well.
24
DuplicateCaseStatement
Check for duplicate case statements in a switch block, such as two equal integers or strings.
25
DuplicateImport
Duplicate import statements are unnecessary.
26
DuplicateMapKey
A map literal is created with duplicated key. The map entry will be overwritten.
27
DuplicateSetValue
A Set literal is created with duplicate constant value. A set cannot contain two elements with the same value.
28
EmptyCatchBlock
In most cases, exceptions should not be caught and ignored (swallowed).
29
EmptyElseBlock
Empty else blocks are confusing and serve no purpose.
30
EmptyFinallyBlock
Empty finally blocks are confusing and serve no purpose.
31
EmptyForStatement
Empty for statements are confusing and serve no purpose.
32
EmptyIfStatement
Empty if statements are confusing and serve no purpose.
33
EmptyInstanceInitializer
An empty class instance initializer was found. It is safe to remove it.
34
EmptyMethod
A method was found without an implementation. If the method is overriding or implementing a parent method, then mark it with the @Override annotation.
35
EmptyStaticInitializer
An empty static initializer was found. It is safe to remove it.
36
EmptySwitchStatement
Empty switch statements are confusing and serve no purpose.
37
EmptySynchronizedStatement
Empty synchronized statements are confusing and serve no purpose.
38
EmptyTryBlock
Empty try blocks are confusing and serve no purpose.
39
EmptyWhileStatement
Empty while statements are confusing and serve no purpose.
40
EqualsAndHashCode
If either the boolean equals(Object) or the int hashCode() methods are overridden within a class, then both must be overridden.
41
EqualsOverloaded
The class has an equals method, but the parameter of the method is not of type Object. It is not overriding equals but instead overloading it.
42
ExplicitGarbageCollection
Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised. Code should have the same behavior whether the garbage collection is disabled using the option -Xdisableexplicitgc or not. Moreover, "modern" jvms do a very good job handling garbage collections. If memory usage issues unrelated to memory leaks develop within an application, it should be dealt with JVM options rather than within the code itself.
43
ForLoopShouldBeWhileLoop
A for loop without an init and update statement can be simplified to a while loop.
44
HardCodedWindowsFileSeparator
This rule finds usages of a Windows file separator within the constructor call of a File object. It is better to use the Unix file separator or use the File.separator constant.
45
HardCodedWindowsRootDirectory
This rule find cases where a File object is constructed with a windows-based path. This is not portable, and using the File.listRoots() method is a better alternative.
46
ImportFromSamePackage
An import of a class that is within the same package is unnecessary.
47
ImportFromSunPackages
Avoid importing anything from the 'sun.*' packages. These packages are not portable and are likely to change.
48
InconsistentPropertyLocking
Class contains similarly-named get and set methods where one method of the pair is marked either @WithReadLock or @WithWriteLock and the other is not locked at all.
49
InconsistentPropertySynchronization
Class contains similarly-named get and set methods where the set method is synchronized and the get method is not, or the get method is synchronized and the set method is not.
50
IntegerGetInteger
This rule catches usages of java.lang.Integer.getInteger(String, ...) which reads an Integer from the System properties. It is often mistakenly used to attempt to read user input or parse a String into an Integer. It is a poor piece of API to use; replace it with System.properties['prop'].
51
JUnitAssertAlwaysFails
Checks for JUnit assert() method calls with constant arguments such that the assertion always fails. This includes: assertTrue(false), assertFalse(true) and assertNull(CONSTANT).
52
JUnitAssertAlwaysSucceeds
Checks for JUnit assert() method calls with constant arguments such that the assertion always succeeds. This includes: assertTrue(true), assertFalse(false) and assertNull(null).
53
JUnitFailWithoutMessage
This rule detects JUnit calling the fail() method without an argument. For better error reporting you should always provide a message.
54
JUnitPublicNonTestMethod
Checks if a JUnit test class contains public methods other than standard test methods, JUnit framework methods or methods with JUnit annotations.
55
JUnitSetUpCallsSuper
Checks that if the JUnit setUp() method is defined, that it includes a call to super.setUp().
56
JUnitTearDownCallsSuper
Checks that if the JUnit tearDown() method is defined, that it includes a call to super.tearDown().
57
JUnitTestMethodWithoutAssert
This rule searches for test methods that do not contain assert statements. Either the test method is missing assert statements, which is an error, or the test method contains custom assert statements that do not follow a proper assert naming convention. Test methods are defined as public void methods that begin with the work test or have a @Test annotation. By default this rule applies to the default test class names, but this can be changed using the rule's applyToClassNames property.
58
JUnitUnnecessarySetUp
Checks for JUnit setUp() methods that contain only a call to super.setUp().
59
JUnitUnnecessaryTearDown
Checks for JUnit tearDown() methods that contain only a call to super.tearDown().
60
MisorderedStaticImports
Static imports should never be declared after nonstatic imports.
61
NestedSynchronization
Nested synchronized statements should be avoided. Nested synchronized statements are either useless (if the lock objects are identical) or prone to deadlock.
62
RandomDoubleCoercedToZero
The Math.random() method returns a double result greater than or equal to 0.0 and less than 1.0. If you coerce this result into an Integer or int, then it is coerced to zero. Casting the result to int, or assigning it to an int field is probably a bug.
63
RemoveAllOnSelf
Don't use removeAll to clear a collection. If you want to remove all elements from a collection c, use c.clear, not c.removeAll(c). Calling c.removeAll(c) to clear a collection is less clear, susceptible to errors from typos, less efficient and for some collections, might throw a ConcurrentModificationException.
64
ReturnFromFinallyBlock
Returning from a finally block is confusing and can hide the original exception.
65
SpockIgnoreRestUsed
If Spock's @IgnoreRest appears on any method, all non-annotated test methods are not executed. This behaviour is almost always unintended. It's fine to use @IgnoreRest locally during development, but when committing code, it should be removed.
66
StaticCalendarField
Calendar objects should not be used as static fields. Calendars are inherently unsafe for multihtreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
67
StaticConnection
Creates violations when a java.sql.Connection object is used as a static field. Database connections stored in static fields will be shared between threads, which is unsafe and can lead to race conditions.
68
StaticDateFormatField
DateFormat objects should not be used as static fields. DateFormat are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
69
StaticMatcherField
Matcher objects should not be used as static fields. Matcher instances are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
70
StaticSimpleDateFormatField
SimpleDateFormat objects should not be used as static fields. SimpleDateFormat are inherently unsafe for multi-threaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
71
SynchronizedMethod
This rule reports uses of the synchronized keyword on methods. Synchronized methods are the same as synchronizing on 'this', which effectively make your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
72
SynchronizedOnBoxedPrimitive
The code synchronizes on a boxed primitive constant, such as an Integer. Since Integer objects can be cached and shared, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness and possible deadlock
73
SynchronizedOnGetClass
Synchronization on getClass rather than class literal. This instance method synchronizes on this.getClass(). If this class is subclassed, subclasses will synchronize on the class object for the subclass, which isn't likely what was intended.
74
SynchronizedOnReentrantLock
Synchronizing on a ReentrantLock field is almost never the intended usage. A ReentrantLock should be obtained using the lock() method and released in a finally block using the unlock() method.
75
SynchronizedOnString
Synchronization on a String field can lead to deadlock because Strings are interned by the JVM and can be shared.
76
SynchronizedOnThis
This rule reports uses of the synchronized blocks where the synchronization reference is 'this'. Doing this effectively makes your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
77
SynchronizedReadObjectMethod
Catches Serializable classes that define a synchronized readObject method. By definition, an object created by deserialization is only reachable by one thread, and thus there is no need for readObject() to be synchronized. If the readObject() method itself is causing the object to become visible to another thread, that is an example of very dubious coding style.
78
SystemRunFinalizersOnExit
Method calls to System.runFinalizersOnExit() should not be allowed. This method is inherently non-thread-safe, may result in data corruption, deadlock, and may effect parts of the program far removed from it's call point. It is deprecated, and it's use strongly discouraged.
79
ThreadGroup
Avoid using ThreadGroup; although it is intended to be used in a threaded environment it contains methods that are not thread safe.
80
ThreadLocalNotStaticFinal
ThreadLocal fields should be static and final. In the most common case a java.lang.ThreadLocal instance associates state with a thread. A non-static non-finaljava.lang.ThreadLocal field associates state with an instance-thread combination. This is seldom necessary and often a bug which can cause memory leaks and possibly incorrect behavior.
81
ThreadYield
Method calls to Thread.yield() should not be allowed. This method has no useful guaranteed semantics, and is often used by inexperienced programmers to mask race conditions.
82
ThrowExceptionFromFinallyBlock
Throwing an exception from a finally block is confusing and can hide the original exception.
83
UnnecessaryBigDecimalInstantiation
It is unnecessary to instantiate BigDecimal objects. Instead just use the decimal literal or the 'G' identifier to force the type, such as 123.45 or 123.45G.
84
UnnecessaryBigIntegerInstantiation
It is unnecessary to instantiate BigInteger objects. Instead just use the literal with the 'G' identifier to force the type, such as 8G or 42G.
85
UnnecessaryBooleanExpression
Checks for unnecessary boolean expressions, including ANDing (&&) or ORing (||) with true, false, null, or a Map/List/String/Number literal. Also checks for negation (!) of true, false, null, or a Map/List/String/Number literal.
86
UnnecessaryBooleanInstantiation
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).
87
UnnecessaryCallForLastElement
This rule checks for excessively verbose methods of accessing the last element of an array or list. For instance, it is possible to access the last element of an array by performing array[array.length - 1], in Groovy it is simpler to either call array.last() or array[-1]. The same is true for lists. This violation is triggered whenever a get, getAt, or array-style access is used with an object size check.
88
UnnecessaryCallToSubstring
Calling String.substring(0) always returns the original string. This code is meaningless.
89
UnnecessaryCatchBlock
Violations are triggered when a catch block does nothing but throw the original exception. In this scenario there is usually no need for a catch block, just let the exception be thrown from the original code. This condition frequently occurs when catching an exception for debugging purposes but then forgetting to take the catch statement out.
90
UnnecessaryCollectCall
Some method calls to Object.collect(Closure) can be replaced with the spread operator. For instance, list.collect { it.multiply(2) } can be replaced by list*.multiply(2).
91
UnnecessaryCollectionCall
Useless call to collections. This call doesn't make sense. For any collection c, calling c.containsAll(c) should always be true, and c.retainAll(c) should have no effect.
92
UnnecessaryConstructor
This rule detects when a constructor is not necessary; i.e., when there's only one constructor, it's public, has an empty body, and takes no arguments.
93
UnnecessaryDefInFieldDeclaration
If a field has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance, 'static def constraints = {}' is redundant and can be simplified to 'static constraints = {}.
94
UnnecessaryDefInMethodDeclaration
If a method has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private method() {}' is redundant and can be simplified to 'private method() {}'.
95
UnnecessaryDefInVariableDeclaration
If a variable has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private n = 2' is redundant and can be simplified to 'private n = 2'.
96
UnnecessaryDotClass
To make a reference to a class, it is unnecessary to specify the '.class' identifier. For instance String.class can be shortened to String.
97
UnnecessaryDoubleInstantiation
It is unnecessary to instantiate Double objects. Instead just use the double literal or the 'D' identifier to force the type, such as 123.45d or 0.42d.
98
UnnecessaryElseStatement
When an if statement block ends with a return statement the else is unnecessary. The logic in the else branch can be run without being in a new scope.
99
UnnecessaryFail
In a unit test, catching an exception and immediately calling Assert.fail() is pointless and hides the stack trace. It is better to rethrow the exception or not catch the exception at all.
100
UnnecessaryFinalOnPrivateMethod
A private method is marked final. Private methods cannot be overridden, so marking it final is unnecessary.
101
UnnecessaryFloatInstantiation
It is unnecessary to instantiate Float objects. Instead just use the float literal with the 'F' identifier to force the type, such as 123.45F or 0.42f.
102
UnnecessaryGetter
Checks for explicit calls to getter/accessor methods which can, for the most part, be replaced by property access. A getter is defined as a method call that matches get[A-Z] but not getClass() or get[A-Z][A-Z] such as getURL(). Getters do not take method arguments.
103
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.
104
UnnecessaryIfStatement
Checks for if statements where the if and else blocks are merely returning true and false constants. These cases can be replaced by a simple return statement.
105
UnnecessaryInstanceOfCheck
This rule finds instanceof checks that cannot possibly evaluate to true. For instance, checking that (!variable instanceof String) will never be true because the result of a not expression is always a boolean.
106
UnnecessaryInstantiationToGetClass
Avoid instantiating an object just to call getClass() on it; use the .class public member instead.
107
UnnecessaryIntegerInstantiation
It is unnecessary to instantiate Integer objects. Instead just use the literal with the 'I' identifier to force the type, such as 8I or 42i.
108
UnnecessaryLongInstantiation
It is unnecessary to instantiate Long objects. Instead just use the literal with the 'L' identifier to force the type, such as 8L or 42L.
109
UnnecessaryModOne
Any expression mod 1 (exp % 1) is guaranteed to always return zero. This code is probably an error, and should be either (exp & 1) or (exp % 2).
110
UnnecessaryNullCheck
Groovy contains the safe dereference operator, which can be used in boolean conditional statements to safely replace explicit "x == null" tests.
111
UnnecessaryNullCheckBeforeInstanceOf
There is no need to check for null before an instanceof; the instanceof keyword returns false when given a null argument.
112
UnnecessaryObjectReferences
Violations are triggered when an excessive set of consecutive statements all reference the same variable. This can be made more readable by using a with or identity block.
113
UnnecessaryOverridingMethod
The overriding method merely calls the same method defined in a superclass
114
UnnecessaryPackageReference
Checks for explicit package reference for classes that Groovy imports by default, such as java.lang.String, java.util.Map and groovy.lang.Closure.
115
UnnecessaryParenthesesForMethodCallWithClosure
If a method is called and the only parameter to that method is an inline closure then the parentheses of the method call can be omitted.
116
UnnecessarySelfAssignment
Method contains a pointless self-assignment to a variable or property.
117
UnnecessaryStringInstantiation
Use a String literal (e.g., "...") instead of calling the corresponding String constructor (new String("..")) directly.
118
UnnecessarySubstring
This rule finds usages of String.substring(int) and String.substring(int, int) that can be replaced by use of the subscript operator. For instance, var.substring(5) can be replaced with var[5..-1].
119
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.
120
UnnecessaryTransientModifier
The field is marked as transient, but the class isn't Serializable, so marking it as transient has no effect.
121
UnusedArray
Checks for array allocations that are not assigned or used, unless it is the last statement within a block.
122
UnusedImport
Imports for a class that is never referenced within the source file is unnecessary.
123
UnusedMethodParameter
This rule finds instances of method parameters not being used. It does not analyze private methods (that is done by the UnusedPrivateMethodParameter rule) or methods marked @Override.
124
UnusedObject
Checks for object allocations that are not assigned or used, unless it is the last statement within a block
125
UnusedPrivateField
Checks for private fields that are not referenced within the same class.
126
UnusedPrivateMethod
Checks for private methods that are not referenced within the same class.
127
UnusedPrivateMethodParameter
Checks for parameters to private methods that are not referenced within the method body.
128
UnusedVariable
Checks for variables that are never referenced.
129
UseAssertEqualsInsteadOfAssertTrue
This rule detects JUnit assertions in object equality. These assertions should be made by more specific methods, like assertEquals.
130
UseAssertFalseInsteadOfNegation
In unit tests, if a condition is expected to be false then there is no sense using assertTrue with the negation operator. For instance, assertTrue(!condition) can always be simplified to assertFalse(condition)
131
UseAssertNullInsteadOfAssertEquals
This rule detects JUnit calling assertEquals where the first or second parameter is null. These assertion should be made against the assertNull method instead.
132
UseAssertSameInsteadOfAssertTrue
This rule detects JUnit calling assertTrue where the first or second parameter is an Object#is() call testing for reference equality. These assertion should be made against the assertSame method instead.
133
UseAssertTrueInsteadOfAssertEquals
This rule detects JUnit calling assertEquals where the first parameter is a boolean. These assertions should be made by more specific methods, like assertTrue or assertFalse.
134
UseAssertTrueInsteadOfNegation
In unit tests, if a condition is expected to be true then there is no sense using assertFalse with the negation operator. For instance, assertFalse(!condition) can always be simplified to assertTrue(condition)
135
UseOfNotifyMethod
This code calls notify() rather than notifyAll(). Java monitors are often used for multiple conditions. Calling notify() only wakes up one thread, meaning that the thread woken up might not be the one waiting for the condition that the caller just satisfied.
136
VolatileArrayField
Volatile array fields are unsafe because the contents of the array are not treated as volatile. Changing the entire array reference is visible to other threads, but changing an array element is not.
137
VolatileLongOrDoubleField
Long or double fields should not be declared as volatile. Java specifies that reads and writes from such fields are atomic, but many JVM's have violated this specification. Unless you are certain of your JVM, it is better to synchronize access to such fields rather than declare them volatile. This rule flags fields marked volatile when their type is double or long or the name of their type is "Double" or "Long".
138
WaitOutsideOfWhileLoop
Calls to Object.wait() must be within a while loop. Consider using the Java concurrency utilities instead of wait() and notify().
CodeNarc includes many predefined rules, but you can also create your own custom rules. See the site navigation menu for a list of rules provided out of the box by CodeNarc. CodeNarc provides abstract superclasses and helper classes for creating new rules.
See this screencast showing how easy it is to create a new rule.
The Rule Interface
All rules must implement the org.codenarc.rule.Rule interface. This interface specifies that all rules must define a name, a priority (from 1 to 3), and also implement the List applyTo(SourceCode sourceCode) method. The method returns the List of Violation objects that result from applying the rule to a single source file.
The AbstractRule Class
The org.codenarc.rule.AbstractRule class is the abstract superclass (or ancestor) for all rules provided with CodeNarc. It provides many standard properties and helper methods for subclasses, as described in Standard Properties for Configuring Rules.
Here is an example rule class that is a subclass of AbstractRule:
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Sample rule. Checks for static fields.
*/
class MyStaticFieldRule extends AbstractRule {
String name = 'MyStaticField'
int priority = 2
void applyTo(SourceCode sourceCode, List violations) {
sourceCode.ast.classes.each { clazz ->
clazz.fields.each { fieldNode ->
if (fieldNode.static) {
violations << createViolation(sourceCode, fieldNode)
}
}
}
}
}
Things to note about MyStaticFieldRule class:
It extends AbstractRule.
It provides name and priority properties as mandated by the Rule interface.
It implements the void applyTo(SourceCode sourceCode, List violations) method which is declared abstract in the AbstractRule superclass.
It accesses the AST for the source code, which is an instance of the org.codehaus.groovy.ast.ModuleNode class from Groovy.
It uses the createViolation() helper method from AbstractRule.
See the CodeNarc source code for other examples (look for rule classes that are direct subclasses of AbstractRule).
The AbstractAstVisitorRule and AbstractAstVisitor Classes
Many of the rules included with CodeNarc are implemented using the Visitor pattern, as supported by the Groovy AST (Abstract Syntax Tree). See the ClassCodeVisitorSupport class within the Groovy distribution (Javadocs).
A Sample Rule Using AbstractAstVisitorRule and AbstractAstVisitor
Here is an example rule class that is a subclass of AbstractAstVisitorRule that uses an associated AST Visitor class that is a subclass of AbstractAstVisitor. This is the code for the EmptyTryBlock rule included with CodeNarc.
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.stmt.TryCatchStatement
import org.codenarc.util.AstUtil
class EmptyTryBlockRule extends AbstractAstVisitorRule {
String name = 'EmptyTryBlock'
int priority = 2
Class astVisitorClass = EmptyTryBlockAstVisitor
}
class EmptyTryBlockAstVisitor extends AbstractAstVisitor {
void visitTryCatchFinally(TryCatchStatement tryCatchStatement) {
if (AstUtil.isEmptyBlock(tryCatchStatement.tryStatement)) {
addViolation(tryCatchStatement)
}
super.visitTryCatchFinally(tryCatchStatement)
}
}
Things to note about this example:
This file contains two classes. The EmptyTryBlockRule class extends AbstractAstVisitorRule. The EmptyTryBlockAstVisitor extends AbstractAstVisitor.
EmptyTryBlockRule includes an astVisitorClass property that specifies that it uses the EmptyTryBlockAstVisitor class.
EmptyTryBlockAstVisitor implements the void visitTryCatchFinally(TryCatchStatement)visitor method defined by the ClassCodeVisitorSupport so that it will visit every try/catch statement within the source code.
It uses the AstUtil utility class.
See the CodeNarc source code and javadocs for more information and further examples.
Creating a Rule Script
You can also create a new rule using a Groovy script file (typically a .groovy file). The script must still define a class that implements the org.codenarc.rule.Rule interface.
The main advantage is that the rule does not have to be compiled into a .class file first, so you can avoid the compile/build phase, and its associated hassles. The Groovy script file is parsed (and compiled) at runtime.
A Sample Rule Script
Here is an example rule script. Note that this is the same source code as in the sample rule class shown above.
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Sample rule script. Checks for static fields.
*/
class MyStaticFieldRule extends AbstractRule {
String name = 'MyStaticField'
int priority = 2
void applyTo(SourceCode sourceCode, List violations) {
sourceCode.ast.classes.each { clazz ->
clazz.fields.each { fieldNode ->
if (fieldNode.static) {
violations << createViolation(sourceCode, fieldNode)
}
}
}
}
}
NOTE: This rule has been DEPRECATED, and disabled by default (i.e., by setting its enabled property to false). Use the AbcMetric rule instead.
Calculates the ABC metric for methods/classes and checks against configured threshold values.
The maxMethodComplexity property holds the threshold value for the ABC complexity value (score) for each method. If this value is non-zero, a method with a complexity value greater than this value is considered a violation.
The maxClassAverageMethodComplexity property holds the threshold value for the average ABC complexity value (score) for each class. If this value is non-zero, a class with an average complexity value greater than this value is considered a violation.
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.
Property
Description
Default Value
maxMethodComplexity
The maximum ABC complexity value (score) allowed for a single method (or "closure field"). If zero or null, then do not check method-level complexity.
60
maxClassAverageMethodComplexity
The maximum ABC complexity average value (score) allowed for a class, calculated as the average complexity of its methods or "closure fields". If zero or null, then do not check class-level average complexity.
60
maxClassComplexity
The maximum ABC complexity value (score) allowed for a class, calculated as the total complexity of its methods or "closure fields". If zero or null, then do not check class-level complexity.
0
ignoreMethodNames
Specifies one or more (comma-separated) method names that that should not cause a rule violation. The names may optionally contain wildcards (*,?). Note that the ignored methods still contribute to the class complexity value.
null
ABC Size/Complexity Metric Calculation Rules
The ABC complexity value (score) is calculated as follows: The ABC metric measures size/complexity by counting the number of Assignments (A), Branches (B) and Conditions (C) and assigns a single numerical score calculated as:
|ABC| = sqrt((A*A)+(B*B)+(C*C))
The ABC Metric calculation rules for Groovy:
Add one to the assignment count for each occurrence of an assignment operator, excluding constant declarations: = *= /= %= += = = &= |= ^= >>>=
Add one to the assignment count for each occurrence of an increment or decrement operator (prefix or postfix): ++ --
Add one to the branch count for each function call or class method call.
Add one to the branch count for each occurrence of the new operator.
Add one to the condition count for each use of a conditional operator: == != = = = =~ ==~
Add one to the condition count for each use of the following keywords: else case default try catch ?
Add one to the condition count for each unary conditional expression.
See the Blog post describing guidelines for interpreting an ABC score
This (Spanish) blog post about the eXcentia Sonar ABC Metric Plugin (for Java) includes a table of risk classifications for ABC scores for both methods and classes.
See the GMetrics ABC metric. This includes a discussion of guidelines for interpreting ABC scores.
This rule requires Groovy 1.6 (or later).
This rule requires the GMetrics jar on the classpath. See GMetrics.
Calculates the ABC size metric for methods/classes and checks against configured threshold values.
The maxMethodAbcScore property holds the threshold value for the ABC score for each method. If this value is non-zero, a method with an ABC score greater than this value is considered a violation. The value does not have to be an integer (e.g., 1.7 is allowed).
The maxClassAverageMethodAbcScore property holds the threshold value for the average ABC score for each class. If this value is non-zero, a class with an average ABC score value greater than this value is considered a violation. The value does not have to be an integer.
The maxClassAbcScore property holds the threshold value for the total ABC score value for each class. If this value is non-zero, a class with a total ABC score greater than this value is considered a violation. The value does not have to be an integer.
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.
Property
Description
Default Value
maxMethodAbcScore
The maximum ABC score allowed for a single method (or "closure field"). If zero or null, then do not check method-level scores.
60
maxClassAverageMethodAbcScore
The maximum average ABC score allowed for a class, calculated as the average score of its methods or "closure fields". If zero or null, then do not check class-level average scores.
60
maxClassAbcScore
The maximum ABC score allowed for a class, calculated as the total ABC score of its methods or "closure fields". If zero or null, then do not check class-level scores.
0
ignoreMethodNames
Specifies one or more (comma-separated) method names that that should not cause a rule violation. The names may optionally contain wildcards (*,?). Note that the ignored methods still contribute to the class complexity value.
null
ABC Size Metric Calculation Rules
The ABC score is calculated as follows: The ABC metric measures size by counting the number of Assignments (A), Branches (B) and Conditions (C) and assigns a single numerical score calculated as:
|ABC| = sqrt((A*A)+(B*B)+(C*C))
The ABC Metric calculation rules for Groovy:
Add one to the assignment count for each occurrence of an assignment operator, excluding constant declarations: = *= /= %= += = = &= |= ^= >>>=
Add one to the assignment count for each occurrence of an increment or decrement operator (prefix or postfix): ++ --
Add one to the branch count for each function call or class method call.
Add one to the branch count for each occurrence of the new operator.
Add one to the condition count for each use of a conditional operator: == != = = = =~ ==~
Add one to the condition count for each use of the following keywords: else case default try catch ?
Add one to the condition count for each unary conditional expression.
See the Blog post describing guidelines for interpreting an ABC score
This (Spanish) blog post about the eXcentia Sonar ABC Metric Plugin (for Java) includes a table of risk classifications for ABC scores for both methods and classes.
See the GMetrics ABC metric. This includes a discussion of guidelines for interpreting ABC scores.
This rule requires Groovy 1.6 (or later).
This rule requires the GMetrics jar on the classpath. See GMetrics.
Calculates the C.R.A.P. (Change Risk Anti-Patterns) metric score for methods/classes and checks against configured threshold values.
The CRAP metric score is based on the cyclomatic complexity and test coverage for individual methods. A method with a CRAP value greater than the maxMethodCrapScore property causes a violation. Likewise, a class that has an (average method) CRAP value greater than the maxClassAverageMethodCrapScore property causes a violation.
NOTE: This rule requires the GMetrics[3] jar, version 0.5 (or later), on the classpath, as well as a Cobertura[4]-[6] XML coverage file. If either of these prerequisites is not available, this rule logs a warning messages and exits (i.e., does nothing).
The maxMethodCrapScore property holds the threshold value for the CRAP 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 maxClassAverageMethodCrapScore property holds the threshold value for the average CRAP 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.
NOTE: This rule does NOT treat closure fields as methods (unlike some of the other size/complexity rules).
Property
Description
Default Value
coberturaXmlFile
The path to the Cobertura XML coverage file for the Groovy code By default, the path is relative to the classpath. But the path may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem), or "http:". This property is REQUIRED.
null
maxMethodCrapScore
The maximum CRAP metric value allowed for a single method. If zero or null, then do not check method-level complexity.
30
maxClassAverageMethodCrapScore
The maximum CRAP average metric value allowed for a class, calculated as the average CRAP value of its methods. If zero or null, then do not check the average class-level CRAP value.
30
maxClassCrapScore
The maximum total CRAP metric value allowed for a class, calculated as the total CRAP value of its methods. If zero or null, then do not check class-level CRAP value.
0
ignoreMethodNames
Specifies one or more (comma-separated) method names that that should not cause a rule violation. The names may optionally contain wildcards (*,?). Note that the ignored methods still contribute to the class complexity value.
null
CRAP Formula
Given a Groovy method m, C.R.A.P. for m is calculated as follows:
Where comp(m) is the cyclomatic complexity of method m, and cov(m) is the test code coverage provided by automated tests.
References
[1] The original 2007 blog post that defined the CRAP metric.
[2] A 2011 blog post from Alberto Savoia (the co-creator of the CRAP metric with Bob Evans), describing the formula, the motivation, and the CRAP4J tool for calculating CRAP score for Java code.
[4]Cobertura -- Cobertura is a free Java tool that calculates the percentage of code accessed by tests. It can be used to identify which parts of your Java program are lacking test coverage.
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 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.
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.
Property
Description
Default Value
maxMethodComplexity
The maximum cyclomatic complexity value allowed for a single method (or "closure field"). If zero or null, then do not check method-level complexity.
20
maxClassAverageMethodComplexity
The maximum average cyclomatic complexity value allowed for a class, calculated as the average complexity of its methods or "closure fields". If zero or null, then do not check average class-level complexity.
20
maxClassComplexity
The maximum total cyclomatic complexity value allowed for a class, calculated as the total complexity of its methods or "closure fields". If zero or null, then do not check total class-level complexity.
0
ignoreMethodNames
Specifies one or more (comma-separated) method names that that should not cause a rule violation. The names may optionally contain wildcards (*,?). Note that the ignored methods still contribute to the class complexity value.
null
Cyclomatic Complexity Metric Calculation Rules
The cyclomatic complexity value is calculated as follows:
Start with a initial (default) value of one (1). Add one (1) for each occurrence of each of the following:
Checks if the number of methods within a class exceeds the number of lines specified by the maxMethod property.
A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.
Property
Description
Default Value
maxMethods
The maximum number of methods allowed in a class definition.
Checks if the size of a method exceeds the number of lines specified by the maxLines property.
Property
Description
Default Value
maxLines
The maximum number of lines allowed in a method definition.
100
ignoreMethodNames
Specifies one or more (comma-separated) method names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
Known Limitations:
Annotations on a method are included in the size (line count) for that method.
Checks for blocks or closures nested more deeply than a configured maximum number. Blocks include if, for, while, switch, try, catch, finally and synchronized blocks/statements, as well as closures.
Methods calls, constructor calls, and property access through Builder objects are ignore. For instance, this code does not cause a violation:
The maximum number of nesting levels. A block or closure nested deeper than that number of levels is considered a violation.
5
ignoreRegex
Determines what is a builder call. For instance, closures nested on a method named createBuilder, a property named myBuilder, or a constructor call to object MyBuilder() do not produce violations.
Checks if the number of parameters in method/constructor exceeds the number of parameters specified by the maxParameters property.
Example of violations:
void someMethod(int arg1, int arg2, int arg3, int arg4, int arg5, int arg6) { // violation
}
class SampleClass {
SampleClass(int arg1, int arg2, int arg3, int arg4, int arg5, int arg6, int arg7) { // violation
}
}
Property
Description
Default Value
maxParameters
The maximum number of parameters in method/constructor
These rules use a later compilation phase for parsing of the Groovy source code, allowing CodeNarc to use a richer and more complete Abstract Syntax Tree (AST). The downside is that the later compiler phase requires CodeNarc to have the application classes being analyzed, as well as any referenced classes, on the classpath.
Note that these rules may be reorganized and moved to a other rulesets or packages. If possible, include them individually within your ruleset -- refer to them using the rule name, e.g. "CloneWithoutCloneable", rather that pulling in the entire "rulesets/enhanced.xml" ruleset, to protect against future reorganization.
The method clone() should only be declared if the class implements the Cloneable interface.
NOTE: This is a CodeNarc Enhanced Classpath Rule. It requires CodeNarc to have the application classes being analyzed, as well as any referenced classes, on the classpath.
Reports usages of org.junit.Assert.assertEquals([message,] expected, actual) where the actual parameter is a constant or a literal. Most likely it was intended to be the expected value.
NOTE: This is a CodeNarc Enhanced Classpath Rule. It requires CodeNarc to have the application classes being analyzed, as well as any referenced classes, on the classpath.
Reports incomplete interface implementations created by map-to-interface coercions.
By default, this rule does not apply to test files.
NOTE: This is a CodeNarc Enhanced Classpath Rule. It requires CodeNarc to have the application classes being analyzed, as well as any referenced classes, on the classpath.
Example of violations:
[mouseClicked: { ... }] as MouseListener
//not all MouseListener methods are implemented which can lead to UnsupportedOperationException-s
[MSG]Static imports should appear before normal imports
Rule Descriptions
#
Rule Name
Description
1
AssertWithinFinallyBlock
Checks for assert statements within a finally block. An assert can throw an exception, hiding the original exception, if there is one.
2
AssignmentInConditional
An assignment operator (=) was used in a conditional test. This is usually a typo, and the comparison operator (==) was intended.
3
BigDecimalInstantiation
Checks for calls to the BigDecimal constructors that take a double parameter, which may result in an unexpected BigDecimal value.
4
BitwiseOperatorInConditional
Checks for bitwise operations in conditionals, if you need to do a bitwise operation then it is best practive to extract a temp variable.
5
BooleanGetBoolean
This rule catches usages of java.lang.Boolean.getBoolean(String) which reads a boolean from the System properties. It is often mistakenly used to attempt to read user input or parse a String into a boolean. It is a poor piece of API to use; replace it with System.properties['prop'].
6
BrokenNullCheck
Looks for faulty checks for null that can cause a NullPointerException.
7
BrokenOddnessCheck
The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check for oddness, consider using x & 1 == 1, or x % 2 != 0.
8
ClassForName
Using Class.forName(...) is a common way to add dynamic behavior to a system. However, using this method can cause resource leaks because the classes can be pinned in memory for long periods of time.
9
ComparisonOfTwoConstants
Checks for expressions where a comparison operator or equals() or compareTo() is used to compare two constants to each other or two literals that contain only constant values., e.g.: 23 == 67, Boolean.FALSE != false, 0.17 <= 0.99, "abc" > "ddd", [a:1] <=> [a:2], [1,2].equals([3,4]) or [a:false, b:true].compareTo(['a':34.5, b:Boolean.TRUE].
10
ComparisonWithSelf
Checks for expressions where a comparison operator or equals() or compareTo() is used to compare a variable to itself, e.g.: x == x, x != x, x <=> x, x < x, x =>= x, x.equals(x) or x.compareTo(x), where x is a variable.
11
ConstantAssertExpression
Checks for assert statements where the assert boolean condition expression is a constant or literal value.
12
ConstantIfExpression
Checks for if statements with a constant value for the if expression, such as true, false, null, or a literal constant value.
13
ConstantTernaryExpression
Checks for ternary expressions with a constant value for the boolean expression, such as true, false, null, or a literal constant value.
14
DeadCode
Dead code appears after a return statement or an exception is thrown. If code appears after one of these statements then it will never be executed and can be safely deleted.
15
DoubleNegative
There is no point in using a double negative, it is always positive. For instance !!x can always be simplified to x. And !(!x) can as well.
16
DuplicateCaseStatement
Check for duplicate case statements in a switch block, such as two equal integers or strings.
17
DuplicateImport
Duplicate import statements are unnecessary.
18
DuplicateMapKey
A map literal is created with duplicated key. The map entry will be overwritten.
19
DuplicateSetValue
A Set literal is created with duplicate constant value. A set cannot contain two elements with the same value.
20
EmptyCatchBlock
In most cases, exceptions should not be caught and ignored (swallowed).
21
EmptyClass
Reports classes without methods, fields or properties. Why would you need a class like this?
22
EmptyElseBlock
Empty else blocks are confusing and serve no purpose.
23
EmptyFinallyBlock
Empty finally blocks are confusing and serve no purpose.
24
EmptyForStatement
Empty for statements are confusing and serve no purpose.
25
EmptyIfStatement
Empty if statements are confusing and serve no purpose.
26
EmptyInstanceInitializer
An empty class instance initializer was found. It is safe to remove it.
27
EmptyMethod
A method was found without an implementation. If the method is overriding or implementing a parent method, then mark it with the @Override annotation.
28
EmptyStaticInitializer
An empty static initializer was found. It is safe to remove it.
29
EmptySwitchStatement
Empty switch statements are confusing and serve no purpose.
30
EmptySynchronizedStatement
Empty synchronized statements are confusing and serve no purpose.
31
EmptyTryBlock
Empty try blocks are confusing and serve no purpose.
32
EmptyWhileStatement
Empty while statements are confusing and serve no purpose.
33
EqualsAndHashCode
If either the boolean equals(Object) or the int hashCode() methods are overridden within a class, then both must be overridden.
34
EqualsOverloaded
The class has an equals method, but the parameter of the method is not of type Object. It is not overriding equals but instead overloading it.
35
ExplicitGarbageCollection
Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised. Code should have the same behavior whether the garbage collection is disabled using the option -Xdisableexplicitgc or not. Moreover, "modern" jvms do a very good job handling garbage collections. If memory usage issues unrelated to memory leaks develop within an application, it should be dealt with JVM options rather than within the code itself.
36
ForLoopShouldBeWhileLoop
A for loop without an init and update statement can be simplified to a while loop.
37
HardCodedWindowsFileSeparator
This rule finds usages of a Windows file separator within the constructor call of a File object. It is better to use the Unix file separator or use the File.separator constant.
38
HardCodedWindowsRootDirectory
This rule find cases where a File object is constructed with a windows-based path. This is not portable, and using the File.listRoots() method is a better alternative.
39
ImportFromSamePackage
An import of a class that is within the same package is unnecessary.
40
ImportFromSunPackages
Avoid importing anything from the 'sun.*' packages. These packages are not portable and are likely to change.
41
IntegerGetInteger
This rule catches usages of java.lang.Integer.getInteger(String, ...) which reads an Integer from the System properties. It is often mistakenly used to attempt to read user input or parse a String into an Integer. It is a poor piece of API to use; replace it with System.properties['prop'].
42
MisorderedStaticImports
Static imports should never be declared after nonstatic imports.
43
MultipleUnaryOperators
Checks for multiple consecutive unary operators. These are confusing, and are likely typos and bugs.
44
NoWildcardImports
Wildcard imports, static or otherwise, should not be used.
45
RandomDoubleCoercedToZero
The Math.random() method returns a double result greater than or equal to 0.0 and less than 1.0. If you coerce this result into an Integer or int, then it is coerced to zero. Casting the result to int, or assigning it to an int field is probably a bug.
46
RemoveAllOnSelf
Don't use removeAll to clear a collection. If you want to remove all elements from a collection c, use c.clear, not c.removeAll(c). Calling c.removeAll(c) to clear a collection is less clear, susceptible to errors from typos, less efficient and for some collections, might throw a ConcurrentModificationException.
47
ReturnFromFinallyBlock
Returning from a finally block is confusing and can hide the original exception.
48
ThrowExceptionFromFinallyBlock
Throwing an exception from a finally block is confusing and can hide the original exception.
49
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.
50
UnusedImport
Imports for a class that is never referenced within the source file is unnecessary.
CodeNarc can be run from the command-line as a Java application. The org.codenarc.CodeNarc class provides the application entry-point.
CodeNarc Command-Line Parameters
Usage: java org.codenarc.CodeNarc [OPTIONS] where OPTIONS are zero or more command-line parameters of the form "-NAME[=VALUE]"
All command-line parameters are optional. If no parameters are supplied, CodeNarc runs from the current directory with reasonable defaults, as described below.
Parameter
Description
Example
-basedir=DIR
The base (root) directory for the source code to be analyzed. Defaults to the current directory (".").
-basedir=src/main/groovy
-includes=PATTERNS
The comma-separated list of Ant-style file patterns specifying files that must be included. Defaults to "**/*.groovy".
-includes=**/*.gr
-excludes=PATTERNS
The comma-separated list of Ant-style file patterns specifying files that must be excluded. No files are excluded when omitted.
-excludes=**/templates/**, **/*Test.*
-rulesetfiles=FILENAMES
The path to the Groovy or XML RuleSet definition files, relative to the classpath. This can be a single file path, or multiple paths separated by commas. Defaults to "rulesets/basic.xml".
The definition of the report to produce. The option value is of the form TYPE[:FILENAME], where TYPE is one of the predefined type names: "html", "xml", "text", "console" or else the fully-qualified class name of a class (accessible on the classpath) that implements the org.codenarc.report.ReportWriter interface. And FILENAME is the filename (with optional path) of the output report filename. If the report filename is omitted, the default filename for the report type is used ("CodeNarcReport.html" for "html" and "CodeNarcXmlReport.xml" for "xml"). If no report option is specified, default to a single "html" report with the default filename.
The title description for this analysis; used in the output report(s), if provided.
-title="My Project"
-help
Display the command-line help. If present, this must be the only command-line parameter.
-help
Executing CodeNarc from the Command-Line
Make sure that the following are included your CLASSPATH:
The Groovy jar
The CodeNarc jar
The Log4J jar
The directories containing (or relative to) CodeNarc config files such as "codenarc.properties" or ruleset files.
The CodeNarc command-line application sets an exit status of zero (0) if the command successfully executes, and an exit status of one (1) if an error occurs executing CodeNarc, or if an invalid command-line option is specified.
Here is an example BAT file for running CodeNarc on Windows.
An assignment operator (=) was used in a conditional test. This is usually a typo, and the comparison operator (==) was intended.
Example of violations:
if ((value = true)) {
// should be ==
}
while (value = true) {
// should be ==
}
(value = true) ? x : y
(value = true) ?: x
// the following code has no violations
if (value == true) {
}
value == true ? x : y
value == true ?: x
Checks for calls to the java.math.BigDecimal constructors that take a double value as the first parameter. As described in the BigDecimal javadoc, the results from these constructors can be somewhat unpredictable, and their use is generally not recommended. This is because some numbers, such as 0.1, cannot be represented exactly as a double.
For instance, executing println new BigDecimal(0.1) prints out 0.1000000000000000055511151231257827021181583404541015625.
Here is an example of code that produces a violation:
def b1 = new BigDecimal(0.1) // violation
def b2 = new java.math.BigDecimal(23.45d) // violation
Checks for bitwise operations in conditionals. For instance, the condition if (a | b) is almost always a mistake and should be if (a || b). If you need to do a bitwise operation then it is best practice to extract a temp variable.
This rule catches usages of java.lang.Boolean.getBoolean(String) which reads a boolean from the System properties. It is often mistakenly used to attempt to read user input or parse a String into a boolean. It is a poor piece of API to use; replace it with System.properties['prop̈́'].
Example of violations:
// produces violation
Boolean.getBoolean(value)
// zero or two parameters is OK, must be different method
Boolean.getBoolean(value, 1)
Boolean.getBoolean()
The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check for oddness, consider using x & 1 == 1, or x % 2 != 0.
Examples:
if (x % 2 == 1) { } // violation
if (method() % 2 == 1) { } // violation
if (x & 1 == 1) { } // OK
if (x % 2 != 0) { } // OK
Using Class.forName(...) is a common way to add dynamic behavior to a system. However, using this method can cause resource leaks because the classes can be pinned in memory for long periods of time. If you're forced to do dynamic class loading then use ClassLoader.loadClass instead. All variations of the Class.forName(...) method suffer from the same problem.
Checks for expressions where a comparison operator or equals() or compareTo() is used to compare two constants to each other or two literals that contain only constant values.
Here are examples of code that produces a violation:
Checks for expressions where a comparison operator or equals() or compareTo() is used to compare a variable to itself, e.g.: x == x, x != x, x <=> x, x < x, x >= x, x.equals(x) or x.compareTo(x), where x is a variable.
Here are examples of code that produces a violation:
if (x == x) { } // violation
if (x != x) { } // violation
while (x < x) { } // violation
if (x <= x) { } // violation
while (x > x) { } // violation
if (x >= x) { } // violation
def c = (x <=> x) { } // violation
println isReady = x.equals(x) // violation
println x.compareTo(x) // violation
Checks for assert statements with a constant value for the assert boolean expression, such as true, false, null, or a literal constant value. These assert statements will always pass or always fail, depending on the constant/literal value. Examples of violations include:
Checks for if statements with a constant value for the if boolean expression, such as true, false, null, or a literal constant value. These if statements can be simplified or avoided altogether. Examples of violations include:
if (true) { .. }
if (false) { .. }
if (Boolean.TRUE) { .. }
if (Boolean.FALSE) { .. }
if (null) { .. }
if (0) { .. }
if (99.7) { .. }
if ("") { .. }
if ("abc") { .. }
if ([:]) { .. }
if ([a:123, b:456]) { .. }
if ([a, b, c]) { .. }
Checks for ternary expressions with a constant value for the boolean expression, such as true, false, null, or a literal constant value. Examples of violations include:
true ? x : y
false ? x : y
Boolean.TRUE ? x : y
Boolean.FALSE ? x : y
null ? x : y
0 ? x : y
99.7 ? x : y
"" ? x : y
"abc" ? x : y
[:] ? x : y
[a:123, b:456] ? x : y
[a, b, c] ? x : y
The rule also checks for the same types of constant values for the boolean expressions within the "short" ternary expressions, also known as the "Elvis" operator, e.g.:
true ?: y
null ?: y
99.7 ?: y
"abc" ?: y
[:] ?: y
[a, b, c] ?: y
Dead code appears after a return statement or an exception is thrown. If code appears after one of these statements then it will never be executed and can be safely deleted.
A Set literal is created with duplicate constant value. A set cannot contain two elements with the same value.
Example of violations:
def a = [1, 2, 2, 4] as Set
def b = [1, 2, 2, 4] as HashSet
def c = [1, 2, 2, 4] as SortedSet
def d = [1, 2, 2, 4] as FooSet
def e = ['1', '2', '2', '4'] as Set
def f = ['1', '2', '2', '4'] as HashSet
def g = ['1', '2', '2', '4'] as SortedSet
def h = ['1', '2', '2', '4'] as FooSet
// these are OK
def a = [1, 2, 3, 4] as Set
def b = ['1', '2', '3', '4'] as Set
def c = [1, '1'] as Set
Checks for empty catch blocks. In most cases, exceptions should not be caught and ignored (swallowed).
The rule has a property named ignoreRegex that defaults to the value 'ignore|ignored'. If the name of the exception matches this regex then no violations are produced.
Property
Description
Default Value
ignoreRegex
Regular expression - exception parameter names matching this regular expression are ignored and no volations are produced.
'ignore
Here is an example of code that produces a violation:
def myMethod() {
try {
doSomething
} catch(MyException e) { //violation
// should do something here
}
}
def myMethod() {
try {
doSomething
} catch(MyException ignored) {
//no violations because the parameter name is ignored
}
}
A method was found without an implementation. If the method is overriding or implementing a parent method, then mark it with the @Override annotation. This rule should not be used with Java 5 code because you cannot put @Override on a method implementing an interface. Use with Java 6 and higher.
Example of violations:
class MyClass {
// violation, empty method
public void method1() {}
// violation, empty method
def method2() {}
// OK because of @Override
@Override
public void method3() {}
}
abstract class MyBaseClass {
// OK, handled by EmptyMethodInAbstractClass Rule
public void method() {}
}
The class has an equals method, but the parameter of the method is not of type Object. It is not overriding equals but instead overloading it.
Example of violations:
class Object1 {
//parameter should be Object not String
boolean equals(String other) { true }
}
class Object2 {
// Overloading equals() with 2 parameters is just mean
boolean equals(Object other, String other2) { true }
}
class Object3 {
// a no-arg equals()? What is this supposed to do?
boolean equals() { true }
}
// all of these are OK and do not cause violations
class Object4 {
boolean equals(Object other) { true }
}
@SuppressWarnings('EqualsOverloaded')
class Object5 {
boolean equals(String other) { true }
}
class Object6 {
boolean equals(java.lang.Object other) { true }
}
class Object7 {
boolean equals(other) { true }
}
Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised. Code should have the same behavior whether the garbage collection is disabled using the option -Xdisableexplicitgc or not. Moreover, "modern" JVMs do a very good job handling garbage collections. If memory usage issues unrelated to memory leaks develop within an application, it should be dealt with JVM options rather than within the code itself.
A for loop without an init and update statement can be simplified to a while loop.
Example of violations:
int i = 0;
for(; i < 5;) { // Violation
println i++
}
// These are OK
for(i in [1,2]) // OK
println i
for(int i = 0; i<5;) // OK
println i++
int i = 0;
for(; i < 5; i++) // OK
println i
for (Plan p : plans) { // OK
println "Plan=$p"
}
This rule finds usages of a Windows file separator within the constructor call of a File object. It is better to use the Unix file separator or use the File.separator constant.
Example of violations:
new File('.\\foo\\')
new File('c:\\dir')
new File('../foo\\')
This rule find cases where a File object is constructed with a windows-based path. This is not portable across operating systems or different machines, and using the File.listRoots() method is a better alternative.
Example of violations:
new File('c:\\')
new File('c:\\dir')
new File('E:\\dir')
This rule catches usages of java.lang.Integer.getInteger(String, ...) which reads an Integer from the System properties. It is often mistakenly used to attempt to read user input or parse a String into an Integer. It is a poor piece of API to use; replace it with System.properties['prop'].
Example of violations:
// violations
Integer.getInteger(value)
Integer.getInteger(value, radix)
// zero or more than 2 parameters is OK, must be different method
Integer.getInteger()
Integer.getInteger(value, radix, locale)
The Math.random() method returns a double result greater than or equal to 0.0 and less than 1.0. If you coerce this result into an Integer, Long, int, or long then it is coerced to zero. Casting the result to int, or assigning it to an int field is probably a bug.
Example of violations:
(int) Math.random()
(Integer) Math.random()
int x = Math.random()
Integer y = Math.random()
int m() { Math.random() }
Integer m() { Math.random() }
(Math.random()) as int
(Math.random()) as Integer
Don't use removeAll to clear a collection. If you want to remove all elements from a collection c, use c.clear, not c.removeAll(c). Calling c.removeAll(c) to clear a collection is less clear, susceptible to errors from typos, less efficient and for some collections, might throw a ConcurrentModificationException.
Checks for throwing an exception from within a finally block. Throwing an exception from a finally block is confusing and can hide the original exception.
Here is an example of code that produces a violation:
int myMethod() {
try {
doSomething()
throw new Exception()
} finally {
println 'finally'
throw new Exception() // violation
}
}
Checks that else blocks use braces, even for a single statement.
By default, braces are not required for an else if it is followed immediately by an if. Set the bracesRequiredForElseIf property to true to require braces is that situation as well.
Property
Description
Default Value
bracesRequiredForElseIf
Set to true to require braces for an else block followed immediately by an if statement.
[MSG]Violation in class org.gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler. getMetaClass() can probably be rewritten as metaClass
[MSG]Violation in class org.gradle.api.internal.file.AntFileCollectionBuilder. Parentheses in the 'null' method call are unnecessary and can be removed.
[MSG]Violation in class AnnouncingBuildListener. Method parameter [task] is never referenced in the method beforeExecute of class org.gradle.api.plugins.announce.internal.AnnouncingBuildListener
[MSG]Violation in class org.gradle.api.plugins.announce.internal.AppleScriptBackedGrowlAnnouncer. The def keyword is unneeded when a method is marked private
[MSG]Violation in class UnknownAnnouncer. Method parameter [title] is never referenced in the method send of class org.gradle.api.plugins.announce.internal.UnknownAnnouncer
[MSG]Violation in class UnknownAnnouncer. Method parameter [message] is never referenced in the method send of class org.gradle.api.plugins.announce.internal.UnknownAnnouncer
[MSG]Violation in class org.gradle.api.plugins.announce.internal.GrowlNotifyBackedAnnouncer. The def keyword is unneeded when a method is marked private
[MSG]Violation in class Twitter. Method parameter [title] is never referenced in the method send of class org.gradle.api.plugins.announce.internal.Twitter
[MSG]Violation in class AbstractCodeQualityPlugin. Method parameter [task] is never referenced in the method configureTaskDefaults of class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin
[MSG]Violation in class AbstractCodeQualityPlugin. Method parameter [baseName] is never referenced in the method configureTaskDefaults of class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin
[SRC]protected void configureForSourceSet(SourceSet sourceSet, T task) {
[MSG]Violation in class AbstractCodeQualityPlugin. Method parameter [sourceSet] is never referenced in the method configureForSourceSet of class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin
[SRC]protected void configureForSourceSet(SourceSet sourceSet, T task) {
[MSG]Violation in class AbstractCodeQualityPlugin. Method parameter [task] is never referenced in the method configureForSourceSet of class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin
[MSG]Violation in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.gradle.api.plugins.quality.internal.AbstractCodeQualityPlugin. The call to collect could probably be rewritten as a spread expression: extension.sourceSets*.getTaskName(taskBaseName, null)
[MSG]Violation in class ScalaBasePlugin. Method parameter [javaPlugin] is never referenced in the method configureCompileDefaults of class org.gradle.api.plugins.scala.ScalaBasePlugin
[MSG]Violation in class org.gradle.api.publication.maven.internal.ant.DefaultMavenPublisher. The def keyword is unneeded when a method is marked private
[MSG]Violation in class org.gradle.api.publication.maven.internal.model.DefaultMavenPublication. getRepository() can probably be rewritten as repository
[MSG]Violation in class PatternSet. Method parameter [childNodeName] is never referenced in the method addToAntBuilder of class org.gradle.api.tasks.util.PatternSet
[MSG]Violation in class IntersectionPatternSet. Method parameter [childNodeName] is never referenced in the method addToAntBuilder of class org.gradle.api.tasks.util.IntersectionPatternSet
[MSG]Violation in class org.gradle.integtests.fixtures.AutoTestedSamplesUtil. Parentheses in the 'each' method call are unnecessary and can be removed.
[MSG]Violation in class org.gradle.integtests.fixtures.CrossVersionTestRunner$PreviousVersionExecution. The String.substring(int, int) method can be replaced with the subscript operator
[MSG]Violation in class HttpServer$TestUserRealm. Method parameter [user] is never referenced in the method reauthenticate of class org.gradle.integtests.fixtures.HttpServer$TestUserRealm
[MSG]Violation in class HttpServer$TestUserRealm. Method parameter [user] is never referenced in the method isUserInRole of class org.gradle.integtests.fixtures.HttpServer$TestUserRealm
[MSG]Violation in class HttpServer$TestUserRealm. Method parameter [role] is never referenced in the method isUserInRole of class org.gradle.integtests.fixtures.HttpServer$TestUserRealm
[MSG]Violation in class HttpServer$TestUserRealm. Method parameter [user] is never referenced in the method disassociate of class org.gradle.integtests.fixtures.HttpServer$TestUserRealm
[MSG]Violation in class HttpServer$TestUserRealm. Method parameter [role] is never referenced in the method pushRole of class org.gradle.integtests.fixtures.HttpServer$TestUserRealm
[MSG]Violation in class HttpServer$TestUserRealm. Method parameter [user] is never referenced in the method logout of class org.gradle.integtests.fixtures.HttpServer$TestUserRealm
[MSG]Violation in class JUnitTestClassExecutionResult. Method parameter [name] is never referenced in the method assertTestSkipped of class org.gradle.integtests.fixtures.JUnitTestClassExecutionResult
[MSG]Violation in class JUnitTestClassExecutionResult. Method parameter [name] is never referenced in the method assertConfigMethodPassed of class org.gradle.integtests.fixtures.JUnitTestClassExecutionResult
[MSG]Violation in class JUnitTestClassExecutionResult. Method parameter [name] is never referenced in the method assertConfigMethodFailed of class org.gradle.integtests.fixtures.JUnitTestClassExecutionResult
[MSG]Violation in class org.gradle.integtests.fixtures.MavenModule. The call to collect could probably be rewritten as a spread expression: names*.replace(-SNAPSHOT, -$timestamp-$build)
[SRC]assert dependencies.collect { it.artifactId} as Set == a..ctIds as Set
[MSG]Violation in class org.gradle.integtests.fixtures.MavenScope. The call to collect could probably be rewritten as a spread expression: dependencies*.artifactId
[MSG]Violation in class org.gradle.integtests.fixtures.PreviousGradleVersionExecuter. The def keyword is unneeded when a method specifies a return type
[MSG]Violation in class org.gradle.integtests.fixtures.PreviousGradleVersionExecuter. The def keyword is unneeded when a method specifies a return type
[MSG]Violation in class SFTPServer$3. Method parameter [username] is never referenced in the method authenticate of class org.gradle.integtests.fixtures.SFTPServer$3
[MSG]Violation in class SFTPServer$3. Method parameter [key] is never referenced in the method authenticate of class org.gradle.integtests.fixtures.SFTPServer$3
[MSG]Violation in class SFTPServer$3. Method parameter [session] is never referenced in the method authenticate of class org.gradle.integtests.fixtures.SFTPServer$3
[MSG]Violation in class DummyPasswordAuthenticator. Method parameter [session] is never referenced in the method authenticate of class org.gradle.integtests.fixtures.DummyPasswordAuthenticator
[MSG]Violation in class TestNgTestClassExecutionResult. Method parameter [testNames] is never referenced in the method assertTestsSkipped of class org.gradle.integtests.fixtures.TestNgTestClassExecutionResult
[SRC]TestClassExecutionResult assertStdout(Matcher<? super St..> matcher) {
[MSG]Violation in class TestNgTestClassExecutionResult. Method parameter [matcher] is never referenced in the method assertStdout of class org.gradle.integtests.fixtures.TestNgTestClassExecutionResult
[SRC]TestClassExecutionResult assertStderr(Matcher<? super St..> matcher) {
[MSG]Violation in class TestNgTestClassExecutionResult. Method parameter [matcher] is never referenced in the method assertStderr of class org.gradle.integtests.fixtures.TestNgTestClassExecutionResult
[MSG]Violation in class org.gradle.integtests.fixtures.TestNativeFileSystemView. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class TestProxyServer$1. Method parameter [httpRequest] is never referenced in the method filter of class org.gradle.integtests.fixtures.TestProxyServer$1
[SRC]def "plugin does not force creation of build dir during ..uration"() {
[MSG]Violation in class WellBehavedPluginTest. The method plugin does not force creation of build dir during configuration is public but not a test method
[MSG]Violation in class org.gradle.plugins.binaries.model.internal.ConfigurationBasedNativeDependencySet. getHeadersConfiguration() can probably be rewritten as headersConfiguration
[MSG]Violation in class CprojectDescriptor. Method parameter [xml] is never referenced in the method store of class org.gradle.plugins.cpp.cdt.model.CprojectDescriptor
[MSG]Violation in class org.gradle.plugins.ear.descriptor.internal.DefaultDeploymentDescriptor. getParentFile() can probably be rewritten as parentFile
[MSG]Violation in class org.gradle.plugins.ear.descriptor.internal.DefaultDeploymentDescriptor. getParentFile() can probably be rewritten as parentFile
[MSG]Violation in class org.gradle.plugins.ide.eclipse.model.EclipseWtpComponent. getLibConfigurations() can probably be rewritten as libConfigurations
[MSG]Violation in class org.gradle.plugins.ide.eclipse.model.internal.FileReferenceFactory. The String.substring(int) method can be replaced with the subscript operator
[SRC]def file = new File(entry.value, path.substring(prefix.length()))
[MSG]Violation in class org.gradle.plugins.ide.eclipse.model.internal.FileReferenceFactory. The String.substring(int) method can be replaced with the subscript operator
[MSG]Violation in class org.gradle.plugins.ide.eclipse.model.internal.FileReferenceFactory$FileReferenceImpl. getJarURL() can probably be rewritten as jarURL
[SRC]dependencies.collect { it.resolve() }.flatten() as LinkedHashSet
[MSG]Violation in class org.gradle.plugins.ide.eclipse.model.internal.WtpComponentFactory. The call to collect could probably be rewritten as a spread expression: dependencies*.resolve()
[MSG]Violation in class org.gradle.plugins.ide.idea.model.ModuleDependency. getAttributeMapForScopeAndExported() can probably be rewritten as attributeMapForScopeAndExported
[MSG]Violation in class org.gradle.plugins.ide.idea.model.ModuleLibrary. getAttributeMapForScopeAndExported() can probably be rewritten as attributeMapForScopeAndExported
[MSG]Violation in class org.gradle.plugins.ide.internal.IdeDependenciesExtractor. The call to collect could probably be rewritten as a spread expression: deps*.resolve()
[MSG]Violation in class org.gradle.plugins.ide.internal.IdeDependenciesExtractor. The call to collect could probably be rewritten as a spread expression: deps*.resolve()
[MSG]Violation in class IdePlugin. Method parameter [target] is never referenced in the method onApply of class org.gradle.plugins.ide.internal.IdePlugin
[MSG]Violation in class org.gradle.plugins.ide.internal.generator.AbstractPersistableConfigurationObject. getDefaultResourceName() can probably be rewritten as defaultResourceName
[MSG]Violation in class XmlPersistableConfigurationObject. Method parameter [xml] is never referenced in the method load of class org.gradle.plugins.ide.internal.generator.XmlPersistableConfigurationObject
[MSG]Violation in class XmlPersistableConfigurationObject. Method parameter [xml] is never referenced in the method store of class org.gradle.plugins.ide.internal.generator.XmlPersistableConfigurationObject
[MSG]Violation in class org.gradle.plugins.signing.signatory.pgp.PgpKeyId. The String.substring(int) method can be replaced with the subscript operator
[SRC]private static final SimpleDateFormat DATE_FORMAT = new .. HH:mm:ss");
[MSG]Violation in class org.gradle.profile.HTMLProfileReport. SimpleDateFormat instances are not thread safe. Wrap the SimpleDateFormat field DATE_FORMAT in a ThreadLocal or make it an instance field
[MSG]Violation in class org.gradle.util.TestPreconditionExtension. Parentheses in the 'any' method call are unnecessary and can be removed.
Rule Descriptions
#
Rule Name
Description
1
AddEmptyString
Finds empty string literals which are being added. This is an inefficient way to convert any type to a String.
2
AssertWithinFinallyBlock
Checks for assert statements within a finally block. An assert can throw an exception, hiding the original exception, if there is one.
3
AssignmentInConditional
An assignment operator (=) was used in a conditional test. This is usually a typo, and the comparison operator (==) was intended.
4
BigDecimalInstantiation
Checks for calls to the BigDecimal constructors that take a double parameter, which may result in an unexpected BigDecimal value.
5
BitwiseOperatorInConditional
Checks for bitwise operations in conditionals, if you need to do a bitwise operation then it is best practive to extract a temp variable.
6
BooleanGetBoolean
This rule catches usages of java.lang.Boolean.getBoolean(String) which reads a boolean from the System properties. It is often mistakenly used to attempt to read user input or parse a String into a boolean. It is a poor piece of API to use; replace it with System.properties['prop'].
7
BrokenNullCheck
Looks for faulty checks for null that can cause a NullPointerException.
8
BrokenOddnessCheck
The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check for oddness, consider using x & 1 == 1, or x % 2 != 0.
9
BusyWait
Busy waiting (forcing a Thread.sleep() while waiting on a condition) should be avoided. Prefer using the gate and barrier objects in the java.util.concurrent package.
10
ChainedTest
A test method that invokes another test method is a chained test; the methods are dependent on one another. Tests should be isolated, and not be dependent on one another.
11
ClassForName
Using Class.forName(...) is a common way to add dynamic behavior to a system. However, using this method can cause resource leaks because the classes can be pinned in memory for long periods of time.
12
ComparisonOfTwoConstants
Checks for expressions where a comparison operator or equals() or compareTo() is used to compare two constants to each other or two literals that contain only constant values., e.g.: 23 == 67, Boolean.FALSE != false, 0.17 <= 0.99, "abc" > "ddd", [a:1] <=> [a:2], [1,2].equals([3,4]) or [a:false, b:true].compareTo(['a':34.5, b:Boolean.TRUE].
13
ComparisonWithSelf
Checks for expressions where a comparison operator or equals() or compareTo() is used to compare a variable to itself, e.g.: x == x, x != x, x <=> x, x < x, x =>= x, x.equals(x) or x.compareTo(x), where x is a variable.
14
ConsecutiveLiteralAppends
Violations occur when method calls to append(Object) are chained together with literals as parameters. The chained calls can be joined into one invocation.
15
ConsecutiveStringConcatenation
Catches concatenation of two string literals on the same line. These can safely by joined.
16
ConstantAssertExpression
Checks for assert statements where the assert boolean condition expression is a constant or literal value.
17
ConstantIfExpression
Checks for if statements with a constant value for the if expression, such as true, false, null, or a literal constant value.
18
ConstantTernaryExpression
Checks for ternary expressions with a constant value for the boolean expression, such as true, false, null, or a literal constant value.
19
CoupledTestCase
This rule finds test cases that are coupled to other test cases, either by invoking static methods on another test case or by creating instances of another test case. If you require shared logic in test cases then extract that logic to a new class where it can properly be reused.
20
CyclomaticComplexity
Checks the cyclomatic complexity for methods/classes.A method (or "closure field") with a cyclomatic complexity value greater than the maxMethodComplexity property (20) causes a violation. Likewise, a class that has an (average method) cyclomatic complexityvalue greater than the maxClassAverageMethodComplexity property (20) causes a violation.
21
DeadCode
Dead code appears after a return statement or an exception is thrown. If code appears after one of these statements then it will never be executed and can be safely deleted.
22
DoubleCheckedLocking
This rule detects double checked locking, where a 'lock hint' is tested for null before initializing an object within a synchronized block. Double checked locking does not guarantee correctness and is an anti-pattern.
23
DoubleNegative
There is no point in using a double negative, it is always positive. For instance !!x can always be simplified to x. And !(!x) can as well.
24
DuplicateCaseStatement
Check for duplicate case statements in a switch block, such as two equal integers or strings.
25
DuplicateImport
Duplicate import statements are unnecessary.
26
DuplicateMapKey
A map literal is created with duplicated key. The map entry will be overwritten.
27
DuplicateSetValue
A Set literal is created with duplicate constant value. A set cannot contain two elements with the same value.
28
EmptyCatchBlock
In most cases, exceptions should not be caught and ignored (swallowed).
29
EmptyElseBlock
Empty else blocks are confusing and serve no purpose.
30
EmptyFinallyBlock
Empty finally blocks are confusing and serve no purpose.
31
EmptyForStatement
Empty for statements are confusing and serve no purpose.
32
EmptyIfStatement
Empty if statements are confusing and serve no purpose.
33
EmptyInstanceInitializer
An empty class instance initializer was found. It is safe to remove it.
34
EmptyMethod
A method was found without an implementation. If the method is overriding or implementing a parent method, then mark it with the @Override annotation.
35
EmptyStaticInitializer
An empty static initializer was found. It is safe to remove it.
36
EmptySwitchStatement
Empty switch statements are confusing and serve no purpose.
37
EmptySynchronizedStatement
Empty synchronized statements are confusing and serve no purpose.
38
EmptyTryBlock
Empty try blocks are confusing and serve no purpose.
39
EmptyWhileStatement
Empty while statements are confusing and serve no purpose.
40
EqualsAndHashCode
If either the boolean equals(Object) or the int hashCode() methods are overridden within a class, then both must be overridden.
41
EqualsOverloaded
The class has an equals method, but the parameter of the method is not of type Object. It is not overriding equals but instead overloading it.
42
ExplicitGarbageCollection
Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised. Code should have the same behavior whether the garbage collection is disabled using the option -Xdisableexplicitgc or not. Moreover, "modern" jvms do a very good job handling garbage collections. If memory usage issues unrelated to memory leaks develop within an application, it should be dealt with JVM options rather than within the code itself.
43
ForLoopShouldBeWhileLoop
A for loop without an init and update statement can be simplified to a while loop.
44
HardCodedWindowsFileSeparator
This rule finds usages of a Windows file separator within the constructor call of a File object. It is better to use the Unix file separator or use the File.separator constant.
45
HardCodedWindowsRootDirectory
This rule find cases where a File object is constructed with a windows-based path. This is not portable, and using the File.listRoots() method is a better alternative.
46
ImportFromSamePackage
An import of a class that is within the same package is unnecessary.
47
ImportFromSunPackages
Avoid importing anything from the 'sun.*' packages. These packages are not portable and are likely to change.
48
InconsistentPropertyLocking
Class contains similarly-named get and set methods where one method of the pair is marked either @WithReadLock or @WithWriteLock and the other is not locked at all.
49
InconsistentPropertySynchronization
Class contains similarly-named get and set methods where the set method is synchronized and the get method is not, or the get method is synchronized and the set method is not.
50
IntegerGetInteger
This rule catches usages of java.lang.Integer.getInteger(String, ...) which reads an Integer from the System properties. It is often mistakenly used to attempt to read user input or parse a String into an Integer. It is a poor piece of API to use; replace it with System.properties['prop'].
51
JUnitAssertAlwaysFails
Checks for JUnit assert() method calls with constant arguments such that the assertion always fails. This includes: assertTrue(false), assertFalse(true) and assertNull(CONSTANT).
52
JUnitAssertAlwaysSucceeds
Checks for JUnit assert() method calls with constant arguments such that the assertion always succeeds. This includes: assertTrue(true), assertFalse(false) and assertNull(null).
53
JUnitFailWithoutMessage
This rule detects JUnit calling the fail() method without an argument. For better error reporting you should always provide a message.
54
JUnitPublicNonTestMethod
Checks if a JUnit test class contains public methods other than standard test methods, JUnit framework methods or methods with JUnit annotations.
55
JUnitSetUpCallsSuper
Checks that if the JUnit setUp() method is defined, that it includes a call to super.setUp().
56
JUnitTearDownCallsSuper
Checks that if the JUnit tearDown() method is defined, that it includes a call to super.tearDown().
57
JUnitTestMethodWithoutAssert
This rule searches for test methods that do not contain assert statements. Either the test method is missing assert statements, which is an error, or the test method contains custom assert statements that do not follow a proper assert naming convention. Test methods are defined as public void methods that begin with the work test or have a @Test annotation. By default this rule applies to the default test class names, but this can be changed using the rule's applyToClassNames property.
58
JUnitUnnecessarySetUp
Checks for JUnit setUp() methods that contain only a call to super.setUp().
59
JUnitUnnecessaryTearDown
Checks for JUnit tearDown() methods that contain only a call to super.tearDown().
60
MisorderedStaticImports
Static imports should never be declared after nonstatic imports.
61
NestedSynchronization
Nested synchronized statements should be avoided. Nested synchronized statements are either useless (if the lock objects are identical) or prone to deadlock.
62
RandomDoubleCoercedToZero
The Math.random() method returns a double result greater than or equal to 0.0 and less than 1.0. If you coerce this result into an Integer or int, then it is coerced to zero. Casting the result to int, or assigning it to an int field is probably a bug.
63
RemoveAllOnSelf
Don't use removeAll to clear a collection. If you want to remove all elements from a collection c, use c.clear, not c.removeAll(c). Calling c.removeAll(c) to clear a collection is less clear, susceptible to errors from typos, less efficient and for some collections, might throw a ConcurrentModificationException.
64
ReturnFromFinallyBlock
Returning from a finally block is confusing and can hide the original exception.
65
SpockIgnoreRestUsed
If Spock's @IgnoreRest appears on any method, all non-annotated test methods are not executed. This behaviour is almost always unintended. It's fine to use @IgnoreRest locally during development, but when committing code, it should be removed.
66
StaticCalendarField
Calendar objects should not be used as static fields. Calendars are inherently unsafe for multihtreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
67
StaticConnection
Creates violations when a java.sql.Connection object is used as a static field. Database connections stored in static fields will be shared between threads, which is unsafe and can lead to race conditions.
68
StaticDateFormatField
DateFormat objects should not be used as static fields. DateFormat are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
69
StaticMatcherField
Matcher objects should not be used as static fields. Matcher instances are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
70
StaticSimpleDateFormatField
SimpleDateFormat objects should not be used as static fields. SimpleDateFormat are inherently unsafe for multi-threaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
71
SynchronizedMethod
This rule reports uses of the synchronized keyword on methods. Synchronized methods are the same as synchronizing on 'this', which effectively make your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
72
SynchronizedOnBoxedPrimitive
The code synchronizes on a boxed primitive constant, such as an Integer. Since Integer objects can be cached and shared, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness and possible deadlock
73
SynchronizedOnGetClass
Synchronization on getClass rather than class literal. This instance method synchronizes on this.getClass(). If this class is subclassed, subclasses will synchronize on the class object for the subclass, which isn't likely what was intended.
74
SynchronizedOnReentrantLock
Synchronizing on a ReentrantLock field is almost never the intended usage. A ReentrantLock should be obtained using the lock() method and released in a finally block using the unlock() method.
75
SynchronizedOnString
Synchronization on a String field can lead to deadlock because Strings are interned by the JVM and can be shared.
76
SynchronizedOnThis
This rule reports uses of the synchronized blocks where the synchronization reference is 'this'. Doing this effectively makes your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
77
SynchronizedReadObjectMethod
Catches Serializable classes that define a synchronized readObject method. By definition, an object created by deserialization is only reachable by one thread, and thus there is no need for readObject() to be synchronized. If the readObject() method itself is causing the object to become visible to another thread, that is an example of very dubious coding style.
78
SystemRunFinalizersOnExit
Method calls to System.runFinalizersOnExit() should not be allowed. This method is inherently non-thread-safe, may result in data corruption, deadlock, and may effect parts of the program far removed from it's call point. It is deprecated, and it's use strongly discouraged.
79
ThreadGroup
Avoid using ThreadGroup; although it is intended to be used in a threaded environment it contains methods that are not thread safe.
80
ThreadLocalNotStaticFinal
ThreadLocal fields should be static and final. In the most common case a java.lang.ThreadLocal instance associates state with a thread. A non-static non-finaljava.lang.ThreadLocal field associates state with an instance-thread combination. This is seldom necessary and often a bug which can cause memory leaks and possibly incorrect behavior.
81
ThreadYield
Method calls to Thread.yield() should not be allowed. This method has no useful guaranteed semantics, and is often used by inexperienced programmers to mask race conditions.
82
ThrowExceptionFromFinallyBlock
Throwing an exception from a finally block is confusing and can hide the original exception.
83
UnnecessaryBigDecimalInstantiation
It is unnecessary to instantiate BigDecimal objects. Instead just use the decimal literal or the 'G' identifier to force the type, such as 123.45 or 123.45G.
84
UnnecessaryBigIntegerInstantiation
It is unnecessary to instantiate BigInteger objects. Instead just use the literal with the 'G' identifier to force the type, such as 8G or 42G.
85
UnnecessaryBooleanExpression
Checks for unnecessary boolean expressions, including ANDing (&&) or ORing (||) with true, false, null, or a Map/List/String/Number literal. Also checks for negation (!) of true, false, null, or a Map/List/String/Number literal.
86
UnnecessaryBooleanInstantiation
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).
87
UnnecessaryCallForLastElement
This rule checks for excessively verbose methods of accessing the last element of an array or list. For instance, it is possible to access the last element of an array by performing array[array.length - 1], in Groovy it is simpler to either call array.last() or array[-1]. The same is true for lists. This violation is triggered whenever a get, getAt, or array-style access is used with an object size check.
88
UnnecessaryCallToSubstring
Calling String.substring(0) always returns the original string. This code is meaningless.
89
UnnecessaryCatchBlock
Violations are triggered when a catch block does nothing but throw the original exception. In this scenario there is usually no need for a catch block, just let the exception be thrown from the original code. This condition frequently occurs when catching an exception for debugging purposes but then forgetting to take the catch statement out.
90
UnnecessaryCollectCall
Some method calls to Object.collect(Closure) can be replaced with the spread operator. For instance, list.collect { it.multiply(2) } can be replaced by list*.multiply(2).
91
UnnecessaryCollectionCall
Useless call to collections. This call doesn't make sense. For any collection c, calling c.containsAll(c) should always be true, and c.retainAll(c) should have no effect.
92
UnnecessaryConstructor
This rule detects when a constructor is not necessary; i.e., when there's only one constructor, it's public, has an empty body, and takes no arguments.
93
UnnecessaryDefInFieldDeclaration
If a field has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance, 'static def constraints = {}' is redundant and can be simplified to 'static constraints = {}.
94
UnnecessaryDefInMethodDeclaration
If a method has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private method() {}' is redundant and can be simplified to 'private method() {}'.
95
UnnecessaryDefInVariableDeclaration
If a variable has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private n = 2' is redundant and can be simplified to 'private n = 2'.
96
UnnecessaryDotClass
To make a reference to a class, it is unnecessary to specify the '.class' identifier. For instance String.class can be shortened to String.
97
UnnecessaryDoubleInstantiation
It is unnecessary to instantiate Double objects. Instead just use the double literal or the 'D' identifier to force the type, such as 123.45d or 0.42d.
98
UnnecessaryElseStatement
When an if statement block ends with a return statement the else is unnecessary. The logic in the else branch can be run without being in a new scope.
99
UnnecessaryFail
In a unit test, catching an exception and immediately calling Assert.fail() is pointless and hides the stack trace. It is better to rethrow the exception or not catch the exception at all.
100
UnnecessaryFinalOnPrivateMethod
A private method is marked final. Private methods cannot be overridden, so marking it final is unnecessary.
101
UnnecessaryFloatInstantiation
It is unnecessary to instantiate Float objects. Instead just use the float literal with the 'F' identifier to force the type, such as 123.45F or 0.42f.
102
UnnecessaryGetter
Checks for explicit calls to getter/accessor methods which can, for the most part, be replaced by property access. A getter is defined as a method call that matches get[A-Z] but not getClass() or get[A-Z][A-Z] such as getURL(). Getters do not take method arguments.
103
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.
104
UnnecessaryIfStatement
Checks for if statements where the if and else blocks are merely returning true and false constants. These cases can be replaced by a simple return statement.
105
UnnecessaryInstanceOfCheck
This rule finds instanceof checks that cannot possibly evaluate to true. For instance, checking that (!variable instanceof String) will never be true because the result of a not expression is always a boolean.
106
UnnecessaryInstantiationToGetClass
Avoid instantiating an object just to call getClass() on it; use the .class public member instead.
107
UnnecessaryIntegerInstantiation
It is unnecessary to instantiate Integer objects. Instead just use the literal with the 'I' identifier to force the type, such as 8I or 42i.
108
UnnecessaryLongInstantiation
It is unnecessary to instantiate Long objects. Instead just use the literal with the 'L' identifier to force the type, such as 8L or 42L.
109
UnnecessaryModOne
Any expression mod 1 (exp % 1) is guaranteed to always return zero. This code is probably an error, and should be either (exp & 1) or (exp % 2).
110
UnnecessaryNullCheck
Groovy contains the safe dereference operator, which can be used in boolean conditional statements to safely replace explicit "x == null" tests.
111
UnnecessaryNullCheckBeforeInstanceOf
There is no need to check for null before an instanceof; the instanceof keyword returns false when given a null argument.
112
UnnecessaryObjectReferences
Violations are triggered when an excessive set of consecutive statements all reference the same variable. This can be made more readable by using a with or identity block.
113
UnnecessaryOverridingMethod
The overriding method merely calls the same method defined in a superclass
114
UnnecessaryPackageReference
Checks for explicit package reference for classes that Groovy imports by default, such as java.lang.String, java.util.Map and groovy.lang.Closure.
115
UnnecessaryParenthesesForMethodCallWithClosure
If a method is called and the only parameter to that method is an inline closure then the parentheses of the method call can be omitted.
116
UnnecessarySelfAssignment
Method contains a pointless self-assignment to a variable or property.
117
UnnecessaryStringInstantiation
Use a String literal (e.g., "...") instead of calling the corresponding String constructor (new String("..")) directly.
118
UnnecessarySubstring
This rule finds usages of String.substring(int) and String.substring(int, int) that can be replaced by use of the subscript operator. For instance, var.substring(5) can be replaced with var[5..-1].
119
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.
120
UnnecessaryTransientModifier
The field is marked as transient, but the class isn't Serializable, so marking it as transient has no effect.
121
UnusedArray
Checks for array allocations that are not assigned or used, unless it is the last statement within a block.
122
UnusedImport
Imports for a class that is never referenced within the source file is unnecessary.
123
UnusedMethodParameter
This rule finds instances of method parameters not being used. It does not analyze private methods (that is done by the UnusedPrivateMethodParameter rule) or methods marked @Override.
124
UnusedObject
Checks for object allocations that are not assigned or used, unless it is the last statement within a block
125
UnusedPrivateField
Checks for private fields that are not referenced within the same class.
126
UnusedPrivateMethod
Checks for private methods that are not referenced within the same class.
127
UnusedPrivateMethodParameter
Checks for parameters to private methods that are not referenced within the method body.
128
UnusedVariable
Checks for variables that are never referenced.
129
UseAssertEqualsInsteadOfAssertTrue
This rule detects JUnit assertions in object equality. These assertions should be made by more specific methods, like assertEquals.
130
UseAssertFalseInsteadOfNegation
In unit tests, if a condition is expected to be false then there is no sense using assertTrue with the negation operator. For instance, assertTrue(!condition) can always be simplified to assertFalse(condition)
131
UseAssertNullInsteadOfAssertEquals
This rule detects JUnit calling assertEquals where the first or second parameter is null. These assertion should be made against the assertNull method instead.
132
UseAssertSameInsteadOfAssertTrue
This rule detects JUnit calling assertTrue where the first or second parameter is an Object#is() call testing for reference equality. These assertion should be made against the assertSame method instead.
133
UseAssertTrueInsteadOfAssertEquals
This rule detects JUnit calling assertEquals where the first parameter is a boolean. These assertions should be made by more specific methods, like assertTrue or assertFalse.
134
UseAssertTrueInsteadOfNegation
In unit tests, if a condition is expected to be true then there is no sense using assertFalse with the negation operator. For instance, assertFalse(!condition) can always be simplified to assertTrue(condition)
135
UseOfNotifyMethod
This code calls notify() rather than notifyAll(). Java monitors are often used for multiple conditions. Calling notify() only wakes up one thread, meaning that the thread woken up might not be the one waiting for the condition that the caller just satisfied.
136
VolatileArrayField
Volatile array fields are unsafe because the contents of the array are not treated as volatile. Changing the entire array reference is visible to other threads, but changing an array element is not.
137
VolatileLongOrDoubleField
Long or double fields should not be declared as volatile. Java specifies that reads and writes from such fields are atomic, but many JVM's have violated this specification. Unless you are certain of your JVM, it is better to synchronize access to such fields rather than declare them volatile. This rule flags fields marked volatile when their type is double or long or the name of their type is "Double" or "Long".
138
WaitOutsideOfWhileLoop
Calls to Object.wait() must be within a while loop. Consider using the Java concurrency utilities instead of wait() and notify().
Typically the licenses listed for the project are that of the project itself, and not of dependencies.
Project License
Apache 2
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.
Checks the location of the opening brace ({) for classes. By default, requires them on the same line, but the sameLine property can be set to false to override this.
NOTE: This rule ignores annotation types, e.g. @interface MyAnnotation .
Checks the location of the opening brace ({) for for loops. By default, requires them on the same line, but the sameLine property can be set to false to override this.
Checks the location of the opening brace ({) for if statements. By default, requires them on the same line, but the sameLine property can be set to false to override this.
Checks the location of the opening brace ({) for constructors and methods. By default, requires them on the same line, but the sameLine property can be set to false to override this.
Checks the location of the opening brace ({) for try statements. By default, requires them on the line, but the sameLine property can be set to false to override this.
Makes sure each class and interface definition is preceded by javadoc. Enum definitions are not checked, due to strange behavior in the Groovy AST. By default, only the main class in a file is checked for Javadoc. The main class is defined as the class that has the same name as the source file, for instance MyClass is the main class in MyClass.groovy but the class MyOtherClass defined in the same source file is not the main class. To check all the classes in the file set the rule property applyToNonMainClasses to true.
Checks for closure logic on first line (after ->) for a multi-line closure. That breaks the symmetry of indentation (if the subsequent statements are indented normally), and that first statement can be easily missed when reading the code.
Example of violations:
def closure = { name -> println name
addToCounts()
println “done” }
Makes sure there are no consecutive lines that are either blank or whitespace only. This reduces the need to scroll further than necessary when reading code, and increases the likelihood that a logical block of code will fit on one screen for easier comprehension.
Checks the maximum length for each line of source code. It checks for number of characters, so lines that include tabs may appear longer than the allowed number when viewing the file. The maximum line length can be configured by setting the length property, which defaults to 120.
NOTE: This rule does not support the @SuppressAnnotations annotation or the classname-based rule properties (applyToClassNames, doNotApplyToClassNames) to enable/disable the rule. If you want to specify or restrict where this rule is applied, you must use the file-based rule properties: applyToFileNames, doNotApplyToFileNames, applyToFilesMatching and doNotApplyToFilesMatching.
Checks that there is at least one space or whitespace following each comma. That includes checks for method and closure declaration parameter lists, method call parameter lists, Map literals and List literals.
Known limitations:
May not catch actual violations if the source line contains unicode character literals, e.g. '\u00A0'
Examples of violations:
def value = calculate(1,399, 'abc') // violation on parameter 399
def method1(int a,String b) { } // violation on parameter b
def closure1 = { int a,String b -> } // violation on parameter b
def list1 = [a,b, c] // violation on list element b
def map1 = [a:1,b:2, c:3] // violation on map element b:2
Check that there is at least one space (blank) or whitespace after each closing brace ("{") for method/class/interface declarations, closure expressions and block statements.
A closure expression followed by a dot operator (.), a comma, a closing parenthesis, the spread-dot operator (*.), a semicolon or the null-safe operator (?.) does not cause a violation.
Property
Description
Default Value
checkClosureMapEntryValue
If false, then do not check for whitespace after closing braces for closure expressions that are literal Map values, e.g. [abc:doStuff()].
true
Known limitations:
May not catch actual violations if the source line contains unicode character literals, e.g. '\u00A0'
Examples of violations and exceptions:
if (ready) { return 9 }else { } // violation
try { doStuff() }finally { } // violation
def matching = list.find { it.isReady() }.filter() // no violation for dot operator
assert list.every { it.isReady() }, "Error" // no violation for comma
def m = [a:123, b:{ println 7 },c:99] // no violation for comma
processItems(list.select { it.isReady() }) // no violation for closing parenthesis
def names = records.findAll { it.age > 1 }*.name // no violation for spread operator
list?.collect { it?.type }?.join(',') // no violation for null-safe operator
Check that there is at least one space (blank) or whitespace after each opening brace ("{") for method/class/interface declarations, closure expressions and block statements.
Property
Description
Default Value
checkClosureMapEntryValue
If false, then do not check for whitespace after opening braces for closure expressions that are literal Map values, e.g. [abc:doStuff()].
true
ignoreEmptyBlock
If true, then allow for [] in code
false
Examples of violations:
class MyClass{int count } // violation
interface MyInterface {static final OK = 1 }// violation
enum MyEnum {OK, BAD } // violation
def myMethod() {int count } // violation
if (ready) {println 9 } // violation
if (ready) {
} else {println 99} // violation
for (int i=0; i<10; i++) {println i } // violation
for (String name in names) {println name } // violation
for (String name: names) {println name } // violation
while (ready) {println time } // violation
try {doStuff() // violation
} catch(Exception e) {x=77 } // violation
} finally {println 'error' } // violation
list.each {name -> } // violation
shouldFail(Exception) {doStuff() } // violation
Check for proper formatting of whitespace around colons for literal Map entries. By default, no whitespace is allowed either before or after the Map entry colon, but you can change that through the configuration properties below.
Property
Description
Default Value
characterBeforeColonRegex
The regular expression that must match the character before the colon (:) for a literal Map entry. For example, /\S/ matches any non-whitespace character and /\s/ matches any whitespace character (thus requiring a space or whitespace).
/\S/ (i.e., no space allowed before the colon)
characterAfterColonRegex
The regular expression that must match the character after the colon (:) for a literal Map entry. For example, /\S/ matches any non-whitespace character and /\s/ matches any whitespace character (thus requiring a space or whitespace).
/\S/ (i.e., no space allowed before the colon)
Example of violations:
Map m1 = [myKey : 12345] // violation (both before and after the colon)
println [a :[1:11, 2:22], // violation on a (before colon)
b:[(Integer): 33]] // violation on Integer (after colon)
Check that there is at least one space (blank) or whitespace before each closing brace ("}") for method/class/interface declarations, closure expressions and block statements.
Property
Description
Default Value
checkClosureMapEntryValue
If false, then do not check for whitespace before closing braces for closure expressions that are literal Map values, e.g. [abc:doStuff()].
true
ignoreEmptyBlock
If true, then allow for [] in code
false
Known limitations:
May not catch actual violations if the source line contains unicode character literals, e.g. '\u00A0'
Examples of violations:
class MyClass { int count} // violation
interface MyInterface { void doStuff()} // violation
enum MyEnum { OK, BAD} // violation
def myMethod() { return 9} // violation
if (ready) { doStuff()} // violation
if (ready) {
} else { return 9} // violation
for (int i=0; i<10; i++) { println i} // violation
for (String name in names) { println name} // violation
for (String name: names) { println name} // violation
while (ready) { doStuff()} // violation
try { doStuff()} // violation
catch(Exception e) { logError(e)} // violation
finally { cleanUp()} // violation
list.each { name -> println name} // violation
shouldFail(Exception) { doStuff()} // violation
Check that there is at least one space (blank) or whitespace before each opening brace ("{") for method/class/interface declarations, closure expressions and block statements.
Property
Description
Default Value
checkClosureMapEntryValue
If false, then do not check for whitespace before opening braces for closure expressions that are literal Map values, e.g. [abc:doStuff()].
true
Known limitations:
May not catch actual violations if the source line contains unicode character literals, e.g. '\u00A0'
Examples of violations:
class MyClass{ } // violation
class MyOtherClass extends AbstractClass{ } // violation
interface MyInterface{ } // violation
enum MyEnum{ OK, BAD } // violation
def myMethod(){ } // violation
if (ready){ } // violation
if (ready) {
} else{} // violation
for (int i=0; i<10; i++){ } // violation
for (String name in names){ } // violation
for (String name: names){ } // violation
while (ready){ } // violation
try{
} finally { } // violation
try {
} catch(Exception e){ } // violation
try {
} finally{ } // violation
list.each{ name -> } // violation
shouldFail(Exception){ doStuff() } // violation
NEW! The preferred way to configure the rules that CodeNarc will use is to create a custom RuleSet specifying the rule names (i.e., without depending on the RuleSet files provided with CodeNarc. This allows finer control over your custom RuleSet and insulates you from the provided RuleSets that can (and often do) change from release to release.
Just Copy and Tweak One of the Starter RuleSet Files
See the Starter RuleSet - All Rules By Category. It contains all of the rules provided with the current version of CodeNarc, organized by category. Just delete or comment out the rules you don't want to use.
Alternatively, there is a Starter RuleSet - All Rules. It contains all of the rules provided with the current version of CodeNarc, in alphabetical order. Just delete or comment out the rules you don't want to use.
The Other RuleSet Options Still Work
You can still create your own custom GroovyRuleSet using the older syntax. You can even mix the new rule-name-only syntax with the older Groovy DSL syntax. It's all good!
You can also continue to use the predefined RuleSets distributed with CodeNarc or you can create your own XMLRuleSet. See the site navigation menu for a list of the RuleSets provided out of the box by CodeNarc.
CodeNarc provides a Groovy DSL (domain-specific language) for defining RuleSets.
The preferred syntax for defining a RuleSet is to specify the list of rules using only the rule names. As mentioned above, this allows finer control over your custom RuleSet and insulates you from the provided RuleSets that can (and often do) change from release to release.
A Sample Groovy RuleSet
Here is an example of a Groovy RuleSet file using the preferred syntax:
The Groovy RuleSet file itself must be accessible on the classpath.
Each rule is specified by its rule name.
The StatelessClass rule redefines the name for that rule instance. You can have multiple instances of the same rule class as long as they have unique rule names.
You can optionally configure a rule instance by specifying rule properties in a Map after the rule name (see ConfusingTernary in the example). Or you can specify rule properties in a Closure after the rule name (see CyclomaticComplexity and StatelessClass in the example).
The easiest way to create a new custom RuleSet is to copy the Starter RuleSet (as a .groovy file). It contains all of the rules provided with the current version of CodeNarc, organized by category. Just delete or comment out the rules you don't want to use.
And here is an example that mixes both the preferred (new) syntax along with the older syntax, to illustrate backward-compatibility:
ruleset {
MethodName
ConfusingTernary(priority:3)
StatelessClass {
name = 'StatelessDao'
applyToClassNames = '*Dao'
}
// Old style
rule(org.codenarc.rule.basic.ThrowExceptionFromFinallyBlockRule) {
priority = 3
}
// Old style
ruleset('rulesets/dry.xml')
}
A Sample Groovy RuleSet Using the Old Syntax
Here is an example of a Groovy RuleSet file using the older syntax:
The Groovy RuleSet file itself must be accessible on the classpath.
The "outer" ruleset defines the contents of the RuleSet (within a closure). It can include an optional description and any combination of ruleset (other RuleSets) and rule statements (individual Rules).
About the "inner" ruleset statements:
Each ruleset statement loads a RuleSet file. The path specifies either a Groovy file or an XML file. By default, the paths specified are relative to the classpath. But these paths may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem), or "http:".
The 'rulesets/basic.xml' RuleSet file is interpreted as an XML file based on the '.xml' extension. Likewise, the 'MyGroovyRuleSet.groovy' file is interpreted as a Groovy RuleSet file.
The RuleSet can be customized by following the RuleSet path with an (optional) closure, containing any combination of the following:
Rule Configurations -- A ruleset statement can optionally provide configuration of the properties for individual rules within the RuleSet. Specify the name of the rule (as a String), followed by its configuration. (Remember to specify the rule name, not the class name. In most cases, the rule name is the class name without the "Rule" suffix). The name of the Rule can be followed by:
A Map of property names and values. See 'EqualsAndHashCode' within the example.
A closure containing property assignments statements. See 'CatchThrowable' within the example.
Properties set this way can be of type String, int, long or boolean.
Rule Filtering (include or exclude statements) -- A ruleset statement can optionally specify include and/or exclude pattern(s) of rule names to include or exclude from the RuleSet. See Filtering Rules Within a RuleSet.
About the rule statements:
Each rule statements loads a single Rule.
The rule statement must specify either:
The class name for a Rule. See ThrowExceptionFromFinallyBlockRule within the example. The Rule class must be available on the classpath.
The path to a Rule Script file. See "MyGroovyRuleSet.groovy" within the example. By default, the paths specified are relative to the classpath. But these paths may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem) or "http:".
A rule can optionally provide configuration of the Rule properties by specifying a closure containing property assignment statements. See ThrowExceptionFromFinallyBlockRule within the example. As within ruleset statements, properties set this way can be of type String, int, long or boolean.
The XML schema for a CodeNarcRuleSet file is embodied in the "ruleset-schema.xsd" file which is included within the CodeNarc jar. It contains three sections, all of which are optional, though the sections must be in the order listed:
XML Tag
Purpose
How many are allowed
<description>
Describe the purpose of the RuleSet
Zero or one
<ruleset-ref>
Include a nested RuleSet, optionally configuring and/or filtering the rules within it. The path to the RuleSet can specify either an XML file or a Groovy RuleSet file.
Zero or more
<rule>
Include a single rule; specify its fully-qualified classname
Zero or more
<rule-script>
Include a single rule implemented by a groovy script; specify the path of the script. The path is relative to the classpath by default, but can optionally specify a URL prefix.
The RuleSet file itself must be accessible on the classpath.
The top-level <ruleset> element must include the namespace declaration shown.
About the <ruleset-ref> elements:
By default, The path of the <ruleset-ref> is relative to the classpath. But these paths may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem) or "http:".
You can optionally set arbitrary properties for the rules within the RuleSet by including one or more <property> elements within a <rule-config> element. In the example above, the DuplicateImportRulepriority property is set to 1. Properties set this way can be of type String, int, long or boolean.
Remember that the name for a <rule-config> specifies the rule name, not the class name. (In most cases, the rule name is the class name without the "Rule" suffix.)
About the <rule> elements:
You must specify the fully-qualified class name for each Rule.
The Rule class must be available on the classpath.
You can optionally set arbitrary properties for individual rules by including a <property> element within a <rule>. For the IllegalRegexRule rule above, the name property is set to "AuthorTagNotAllowed" and the regex property is set to "\@author". Properties set this way can be of type String, int, long or boolean.
Because the name property is customized for the IllegalRegexRule, the localized rule description will be retrieved from the custom messages resource bundle file ("codenarc-messages.properties"), if that bundle file exists, otherwise a default generic message will be used. The resource bundle message key will be based on the customized name. In this case, the message key will be "AuthorTagNotAllowed.description".
About the <rule-script> elements:
You must specify the path for the rule script Groovy file. By default, this path is relative to the classpath. But these paths may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem) or "http:".
The class defined within the rule script Groovy file must implement the org.codenarc.rule.Rule interface.
You can optionally set arbitrary properties for the rule by including a <property> element within a <rule-script> the same way you can for a <rule>. That is not shown here.
You can use the <include> and <exclude> elements within a <ruleset-ref> to filter a RuleSet and include and/or the exclude individual rules. In the following RuleSet excerpt, the entire "rulesets/basic.xml" RuleSet is included, except for the BooleanInstantiationRule and StringInstantiationRule.
Alternatively, you may wish to explicitly specify the rules that you want included from a RuleSet rather than those that are excluded. In the following RuleSet excerpt, ONLY the ReturnFromFinallyBlockRule and StringInstantiationRule rules are included from the "rulesets/basic.xml" RuleSet.
ruleset('rulesets/basic.xml') {
include 'ReturnFromFinallyBlockRule'
include 'StringInstantiation'
}
And here is the same example in XML RuleSet format:
Note: In all cases, the rule name is specified, not the class name. (In most cases, the rule name is the class name without the "Rule" suffix.)
Note: If you specify at least one <include>, then ONLY rules matching an <include> will be included.
Note: If you specify an <include> and an <exclude> for a rule, then the <exclude> takes precedence.
Using Wildcards Within <include> and <exclude> Names
You may optionally include wildcard characters ('*' or '?') in the rule name for both <include> and an <exclude> elements. The wildcard character '*' within the name matches a sequence of zero or more characters in the rule name, while the wildcard character '?' within the name matches exactly one character in the rule name.
In the following RuleSet excerpt, all rules matching '*Instantiation' are included from the "rulesets/basic.xml" RuleSet. In this case, that will include the StringInstantiationRule and BooleanInstantiationRule rules.
Verifies that the name of an abstract class matches the regular expression specified in the regex property. If that property is null or empty, then this rule is not applied (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active. This rule ignores interfaces and is applied only to abstract classes.
Property
Description
Default Value
regex
Specifies the regular expression used to validate the abstract class name. If null or empty, then this rule does nothing.
Verifies that the name of a class matches a regular expression. By default it checks that the class name starts with an uppercase letter and is followed by zero or more word characters (letters, numbers or underscores) or dollar signs ($).
Property
Description
Default Value
regex
Specifies the regular expression used to validate the class name. It is required and cannot be null or empty.
Checks for very confusing method names. The referenced methods have names that differ only by capitalization. This is very confusing because if the capitalization were identical then one of the methods would override the other.
Also, violations are triggered when methods and fields have very similar names.
A factory method is a method that creates objects, and they are typically named either buildFoo(), makeFoo(), or createFoo(). This rule enforces that only one naming convention is used. It defaults to allowing makeFoo(), but that can be changed using the property regex. The regex is a negative expression; it specifically bans methods named build* or create*. However, methods named build or build* receive some special treatment because of the popular Builder Pattern. If the 'build' method is in a class named *Builder then it does not cause a violation.
Builder methods are slightly different than factory methods.
Property
Description
Default Value
regex
Specifies the default regular expression used to validate the method name. It is required and cannot be null or empty.
/(build.*|create.*)/
Example of violations:
class MyClass {
// violation. Factory methods should be named make()
def create() {
}
// violation. Factory methods should be named make()
def createSomething() {
}
// violation. Builder method not in class named *Builder
def build() {
}
// violation. Builder method not in class named *Builder
def buildSomething() {
}
// this is OK because it is called make
def make() {
}
// this is also OK
def makeSomething() {
}
// OK, overriding a parent
@Override
build() { }
}
class WidgetBuilder {
// OK, the class name ends in Builder
def build() {
}
}
Verifies that the name of each field matches a regular expression. By default it checks that fields that are not static final have field names that start with a lowercase letter and contains only letters or numbers. By default, static final field names start with an uppercase letter and contain only uppercase letters, numbers and underscores.
NOTE: This rule checks only regular fields of a class, not properties. In Groovy, properties are fields declared with no access modifier (public, protected, private). Thus, this rule only checks fields that specify an access modifier. For naming of properties, see PropertyNameRule.
Property
Description
Default Value
regex
Specifies the default regular expression used to validate the field name. It is required and cannot be null or empty.
/[a-z][a-zA-Z0-9]*/
finalRegex
Specifies the regular expression used to validate final field names. It is optional. If not set, then final fields that are non-static are validated using regex.
null
staticRegex
Specifies the regular expression used to validate static field names. It is optional. If not set, then static fields that are non-final are validated using regex.
null
staticFinalRegex
Specifies the regular expression used to validate static final field names. It is optional. If not set, then static final fields are validated using finalRegex, staticRegex or regex.
/[A-Z][A-Z0-9_]*/
ignoreFieldNames
Specifies one or more (comma-separated) field names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
serialVersionUID
The order of precedence for the regular expression properties is: staticFinalRegex, finalRegex, staticRegex and finally regex. In other words, the first regex in that list matching the modifiers for the field is the one that is applied for the field name validation.
Verifies that the name of an interface matches the regular expression specified in the regex property. If that property is null or empty, then this rule is not applied (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active.
Property
Description
Default Value
regex
Specifies the regular expression used to validate the name of an interface. If null or empty, then this rule does nothing.
Verifies that the name of each method matches a regular expression. By default it checks that the method name starts with a lowercase letter. Implicit method names are ignored (i.e., 'main' and 'run' methods automatically created for Groovy scripts).
Property
Description
Default Value
regex
Specifies the regular expression used to validate the method name. It is required and cannot be null or empty.
/[a-z] w*/
ignoreMethodNames
Specifies one or more (comma-separated) method names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
Verifies that the package name of a class matches a regular expression. By default it checks that the package name consists of only lowercase letters and numbers, separated by periods.
Property
Description
Default Value
regex
Specifies the regular expression used to validate the package name. It is required and cannot be null or empty.
/[a-z]+[a-z0-9]*( .[a-z0-9]+)*/
packageNameRequired
Indicates whether a package name declaration is required for all classes.
A package source file's path should match the package declaration.
Property
Description
Default Value
groupId
Specifies the common group id part of a package name, that will appear within all checked package names. It must also map to the file path for the corresponding source file. For instance, a groupId of "org.sample" means that for all classes that specify a package, that package name must include "org.sample", and the source file must exist under an "org/sample" directory. Then, a MyClass class in a org.sample.util package must be defined in a "MyClass.groovy" file within a "org/sample/util" directory. That directory can be the child of any arbitrary root path, e.g. "src/main/groovy". To find the sub-path relevant for the package the rule searches for the first appearance of groupId in the file path. It's required to configure this. If groupId is null or empty, this rule does nothing.
Verifies that the name of each parameter matches a regular expression. This rule applies to method parameters, constructor parameters and closure parameters. By default it checks that parameter names start with a lowercase letter and contains only letters or numbers.
Property
Description
Default Value
regex
Specifies the regular expression used to validate the parameter name. It is required and cannot be null or empty.
/[a-z][a-zA-Z0-9]*/
ignoreParameterNames
Specifies one or more (comma-separated) parameter names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
Verifies that the name of each property matches a regular expression. By default it checks that property names (other than static final) start with a lowercase letter and contains only letters or numbers. By default, static final property names start with an uppercase letter and contain only uppercase letters, numbers and underscores.
NOTE: This rule checks only properties of a class, not regular fields. In Groovy, properties are fields declared with no access modifier (public, protected, private). For naming of regular fields, see FieldNameRule.
Property
Description
Default Value
regex
Specifies the default regular expression used to validate the property name. It is required and cannot be null or empty.
/[a-z][a-zA-Z0-9]*/
finalRegex
Specifies the regular expression used to validate final property names. It is optional. If not set, then final properties that are non-static are validated using regex.
null
staticRegex
Specifies the regular expression used to validate static property names. It is optional. If not set, then static properties that are non-final are validated using regex.
null
staticFinalRegex
Specifies the regular expression used to validate static final property names. It is optional. If not set, then static final property are validated using finalRegex, staticRegex or regex.
/[A-Z][A-Z0-9_]*/
ignorePropertyNames
Specifies one or more (comma-separated) property names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
The order of precedence for the regular expression properties is: staticFinalRegex, finalRegex, staticRegex and finally regex. In other words, the first regex in that list matching the modifiers for the property is the one that is applied for the field name validation.
Verifies that the name of each variable matches a regular expression. By default it checks that non-final variable names start with a lowercase letter and contains only letters or numbers. By default, final variable names start with an uppercase letter and contain only uppercase letters, numbers and underscores.
Property
Description
Default Value
regex
Specifies the default regular expression used to validate the variable name. It is required and cannot be null or empty.
/[a-z][a-zA-Z0-9]*/
finalRegex
Specifies the regular expression used to validate final variable names. It is optional. If not set, then regex is used to validate final variable names.
/[A-Z][A-Z0-9_]*/
ignoreVariableNames
Specifies one or more (comma-separated) variable names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
The org.codenarc.report.TextReportWriter class (type="text") produces a simple text report of the CodeNarc results. See a Sample Report.
The org.codenarc.report.IdeTextReportWriter class (type="ide") also produces a text report of the CodeNarc results, and includes IDE-compatible (Eclipse, Idea) hyperlinks to source code for violations.
Option Nested Elements
The option element is a child of the report element and defines a report-specific option for a report.
The TextReportWriter and IdeTextReportWriter classes supports the following options:
Attribute
Description
Required
maxPriority
The maximum priority level for violations in the report. For instance, setting maxPriority to 2 will result in the report containing only priority 1 and 2 violations (and omitting violations with priority 3).
3
outputFile
The path and filename for the output report file.
No
title
The title for the output report.
No
writeToStandardOut
Set to "true" or true to write out the report to stdout (System.out) instead of writing to a file.
No
Examples
Here is an example Ant XML build file illustrating configuration of org.codenarc.report.TextReportWriter. Note that the report type is specified as "text".
Here is an example Ant XML build file illustrating configuration of org.codenarc.report.IdeTextReportWriter. Note that the report type is specified as "ide". The "ide" report type will automatically write the report to stdout.
This rule checks for duplicate List literals within the current class. This rule only checks for Lists where values are all constants or literals.
Code containing duplicate List literals can usually be improved by declaring the List as a constant field.
By default, the rule does not analyze test files. This rule sets the default value of the doNotApplyToFilesMatching property to ignore file names ending in 'Test.groovy', 'Tests.groovy' or 'TestCase.groovy'.
def name
def var1 = [name, 'b', 'c']
def var2 = [name, 'b', 'c'] // not a violation; name is a variable
def var1 = [1, 7+5]
def var2 = [1, 7+5] // not a violation; contains a non-constant/literal expression
Notes
This rule does not search across several files at once, only in the current file, and only within the current class.
You can suppress the error by annotating a class or method with the @SuppressWarnings('DuplicateListLiteral') annotation.
This rule checks for duplicate Map literals within the current class. This rule only checks for Maps where the keys and values are all constants or literals.
Code containing duplicate Map literals can usually be improved by declaring the Map as a constant field.
By default, the rule does not analyze test files. This rule sets the default value of the doNotApplyToFilesMatching property to ignore file names ending in 'Test.groovy', 'Tests.groovy' or 'TestCase.groovy'.
def name
def var1 = [(name):1, b:1, c:1]
def var2 = [(name):1, b:1, c:1] // not a violation; name is a variable
def var1 = [a:1, b:['x', name]]
def var2 = [a:1, b:['x', name]] // not a violation; name is a variable
def var1 = [a:7+5]
def var2 = [a:7+5] // not a violation; contains a non-constant/literal expression
Notes
This rule does not search across several files at once, only in the current file, and only within the current class.
You can suppress the error by annotating a class or method with the @SuppressWarnings('DuplicateMapLiteral') annotation.
This rule checks for duplicate number literals within the current class.
Code containing duplicate Number literals can usually be improved by declaring the Number as a constant field.
By default, the rule does not analyze test files. This rule sets the default value of the doNotApplyToFilesMatching property to ignore file names ending in 'Test.groovy', 'Tests.groovy' or 'TestCase.groovy'.
Property
Description
Default Value
ignoreNumbers
The optional comma-separated list of numbers that should be ignored (i.e., not cause a violation).
0,1
Notes
This rule does not search across several files at once, only in the current file, and only within the current class.
You can suppress the error by annotating a class or method with the @SuppressWarnings('DuplicateNumberLiteral') annotation.
This rule checks for duplicate String literals within the current class.
Code containing duplicate String literals can usually be improved by declaring the String as a constant field.
By default, the rule does not analyze test files. This rule sets the default value of the doNotApplyToFilesMatching property to ignore file names ending in 'Test.groovy', 'Tests.groovy' or 'TestCase.groovy'.
Property
Description
Default Value
ignoreStrings
The optional comma-separated list of Strings that should be ignored (i.e., not cause a violation).
'' (empty string)
Notes
This rule does not search across several files at once, only in the current file, and only within the current class.
You can suppress the error by annotating a class or method with the @SuppressWarnings('DuplicateStringLiteral') annotation.
Several newer rules use a later compilation phase for parsing of the Groovy source code, allowing CodeNarc to use a richer and more complete Abstract Syntax Tree (AST). The downside is that the later compiler phase requires CodeNarc to have the application classes being analyzed, as well as any referenced classes, on the classpath.
NOTE: If a rule requiring a later compiler phase is included in the active CodeNarc ruleset and enabled and one or more of the required classes is not on the classpath, then CodeNarc will log a Log4J WARN message for each source file that contains the missing references.
Grails-CodeNarc Plugin
The Grails CodeNarc Plugin supports the new enhanced classpath rules out of the box. You are free to include these rules in your CodeNarc ruleset when you use the Grails CodeNarc plugin.
CodeNarc Ant Task - Expanding the Classpath
TBD...
CodeNarc users that use the Ant Task directly will need to adjust their Ant scripts to expand the classpath, if they want to take advantage of these special new rules.
See the CodeNarc Ant Task for more information on configuring the Ant task.
CodeNarc - Other Tools and Frameworks - Expanding the Classpath?
Other tools/frameworks that use CodeNarc will most likely not be able to use these new rules initially, because the tool classpath will not support it. The hope is that the other CodeNarc tools will eventually be enhanced to provide the expanded classpath to CodeNarc – either optionally or always – so that they can also take advantage of these new rules.
We also expect to continue to introduce more of these "special" enhanced-classpath rules, since that greatly expands the capabilities for CodeNarc rules.
Anyone who does not want to use the new rules or is unable to expand the classpath as required, can just omit these special rules from the CodeNarc ruleset or else disable the rules.
In a ternary expression avoid negation in the test. For example, rephrase: (x != y) ? diff : same as: (x == y) ? same : diff. Consistent use of this rule makes the code easier to read. Also, this resolves trivial ordering problems, such as "does the error case go first?" or "does the common case go first?".
Example:
(x != y) ? diff : same // triggers violation
(!x) ? diff : same // triggers violation
(x == y) ? same : diff // OK
(x) ? same : diff // OK
// this is OK, because of GroovyTruth there is no inverse of != null
(x != null) ? diff : same
// this is OK, because of GroovyTruth there is no inverse of != true
(x != true) ? diff : same
// this is OK, because of GroovyTruth there is no inverse of != false
(x != false) ? diff : same
Catch an if block that could be written as an elvis expression.
Example of violations:
if (!x) { // violation
x = 'some value'
}
if (!x) // violation
x = "some value"
if (!params.max) { // violation
params.max = 10
}
x ?: 'some value' // OK
Checks for references to the (effectively) obsolete java.util.Hashtable class. Use the Java Collections Framework classes instead, including HashMap or ConcurrentHashMap. See the JDK javadoc.
An if statement where both the if and else blocks contain only a single return statement returning a constant or literal value.
A block where the second-to-last statement in a block is an if statement with no else, where the block contains a single return statement, and the last statement in the block is a return statement, and both return statements return a constant or literal value. This check is disabled by setting checkLastStatementImplicitElse to false.
An inverted if-else statement is one in which there is a single if statement with a single else branch and the boolean test of the if is negated. For instance if (!x) false else true. It is usually clearer to write this as if (x) true else false.
In Java and Groovy, you can specify long literals with the L or l character, for instance 55L or 24l. It is best practice to always use an uppercase L and never a lowercase l. This is because 11l rendered in some fonts may look like 111 instead of 11L.
Do not allow using the def keyword in code. Use a specific type instead.
Property
Description
Default Value
excludeRegex
Regular expression describing names of attributes, parameters or methods that could be precede by the def keyword.
NOTE: This rule applies to the text contents of a file rather than a specific class, so it does not support the applyToClassNames and doNotApplyToClassNames configuration properties.
Checks for a method or closure parameter being reassigned to a new value within the body of the method/closure, which is a confusing and questionable practice. Use a temporary variable instead.
Example of violations:
void myMethod(int a, String b) {
println a
b = 'new value' // violation
}
def myClosure1 = { int a, b ->
a = 123 // violation
}
Checks for ternary expressions where the boolean and true expressions are the same. These can be simplified to an Elvis expression.
Example of violations:
x ? x : false // violation; can simplify to x ?: false
foo() ? foo() : bar() // violation; can simplify to foo() ?: bar()
foo(1) ? foo(1) : 123 // violation; can simplify to foo(1) ?: 123
(x == y) ? same : diff // OK
x ? y : z // OK
x ? x + 1 : x + 2 // OK
x ? 1 : 0 // OK
x ? !x : x // OK
!x ? x : null // OK
foo() ? bar() : 123 // OK
foo() ? foo(99) : 123 // OK
foo(x) ? foo() : 123 // OK
foo(1) ? foo(2) : 123 // OK
NOTE: If the boolean and true expressions are the same method call, and that method call has side-effects, then converting it to a Elvis expression may produce different behavior. The method will only be called once, rather than twice. But relying on those side-effects as part of a ternary expression behavior is confusing, error-prone and just a bad idea. In any case, that code should be refactored to move the reliance on the side-effects out of the ternary expression.
Checks for references to the (effectively) obsolete java.util.Vector class. Use the Java Collections Framework classes instead, including ArrayList or Collections.synchronizedList(). See the JDK javadoc.
The abstract class does not contain any abstract methods. An abstract class suggests an incomplete implementation, which is to be completed by subclasses implementing the abstract methods. If the class is intended to be used as a base class only (not to be instantiated directly) a protected constructor can be provided prevent direct instantiation.
Example:
public abstract class MyBaseClass {
void method1() { }
void method2() { }
// consider using abstract methods or removing
// the abstract modifier and adding protected constructors
}
The following examples all pass:
abstract class MyClass extends AbstractParent {
// OK because parent is named Abstract.*
}
abstract class MyClass extends BaseParent{
// OK because parent is named Base.*
}
Checks for a method with Boolean return type that returns an explicit null. A method that returns either Boolean.TRUE, Boolean.FALSE or null is an accident waiting to happen. This method can be invoked as though it returned a value of type boolean, and the compiler will insert automatic unboxing of the Boolean value. If a null value is returned, this will result in a NullPointerException.
A builder method is defined as one that creates objects. As such, they should never be of void return type. If a method is named build, create, or make, then it should always return a value.
This rule has one property: methodNameRegex. The default value is (make.*|create.*|build.*). Update this property if you have some other naming convention for your builder methods.
If you implement a compareTo method then you should also implement the Comparable interface. If you don't then you could possibly get an exception if the Groovy == operator is invoked on your object. This is an issue fixed in Groovy 1.8 but present in previous versions.
Here is an example of code that produces a violation:
class BadClass {
int compareTo(Object o) { ... }
}
An empty method in an abstract class should be abstract instead, as developer may rely on this empty implementation rather than code the appropriate one.
abstract class MyClass {
def couldBeAbstract_1() {
return null // Should be abstract method
}
void couldBeAbstract_2() {
// Should be abstract method
}
}
This rule finds classes marked final that contain protected members. If a class is final then it may not be subclassed, and there is therefore no point in having a member with protected visibility. Either the class should not be final or the member should be private or protected.
Checks for use of the following concrete classes when specifying the type of a method parameter, closure parameter, constructor parameter, method return type or field type. The corresponding interfaces should be used to specify the type instead.
java.util.ArrayList
java.util.GregorianCalendar
java.util.HashMap
java.util.HashSet
java.util.Hashtable
java.util.LinkedHashMap
java.util.LinkedHashSet
java.util.LinkedList
java.util.TreeMap
java.util.TreeSet
java.util.Vector
java.util.concurrent.ArrayBlockingQueue
java.util.concurrent.ConcurrentHashMap
java.util.concurrent.ConcurrentLinkedQueue
java.util.concurrent.CopyOnWriteArrayList
java.util.concurrent.CopyOnWriteArraySet
java.util.concurrent.DelayQueue
java.util.concurrent.LinkedBlockingQueue
java.util.concurrent.PriorityBlockingQueue
java.util.concurrent.PriorityQueue
java.util.concurrent.SynchronousQueue
Here are examples of code that produces violations:
Checks for use of the instanceof operator. Prefer using polymorphism instead.
Use the ignoreTypeNames property to configure ignored type names (the class name specified as the right-hand expression of the instanceof). It defaults to ignoring instanceof checks against exception classes.
Here are a couple references that discuss the problems with using instanceof and the preference for using polymorphism instead:
By default, the rule does not analyze test files. This rule sets the default value of the doNotApplyToFilesMatching property to ignore file names ending in 'Test.groovy', 'Tests.groovy' or 'TestCase.groovy'.
Property
Description
Default Value
ignoreTypeNames
Specifies one or more (comma-separated) class names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
*Exceptions
Example of violations:
class MyClass {
boolean isRunnable = this instanceof Runnable // violation
}
Checks for calls to Locale.setDefault(), or Locale.default = Xxx, which sets the Locale across the entire JVM. That can impact other applications on the same web server, for instance.
From the java.util.Locale javadoc for setDefault: Since changing the default locale may affect many different areas of functionality, this method should only be used if the caller is prepared to reinitialize locale-sensitive code running within the same Java Virtual Machine.
This rule finds private fields that are only set within a constructor or field initializer. Such fields can safely be made final.
Property
Description
Default Value
ignoreFieldNames
Specifies one or more (comma-separated) field names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
ignoreJpaEntities
Specifies whether fields defined inside classes annotated with @Entity or @MappedSuperclass JPA annotations should be ignored (i.e., that should not cause a rule violation).
If you have a method or closure that returns an array, then when there are no results return a zero-length (empty) array rather than null. It is often a better design to return a zero-length array rather than a null reference to indicate that there are no results (i.e., an empty list of results). This way, no explicit check for null is needed by clients of the method.
If you have a method or closure that returns a collection, then when there are no results return a zero-length (empty) collection rather than null. It is often a better design to return a zero-length collection rather than a null reference to indicate that there are no results (i.e., an empty list of results). This way, no explicit check for null is needed by clients of the method.
Be sure to specify a Locale when creating a new instance of SimpleDateFormat; the class is locale-sensitive. If you instantiate SimpleDateFormat without a Locale parameter, it will format the date and time according to the default Locale. Both the pattern and the Locale determine the format. For the same pattern, SimpleDateFormat may format a date and time differently if the Locale varies.
// violation, missing locale
new SimpleDateFormat('pattern')
// OK, includes locale
new SimpleDateFormat('pattern', Locale.US)
// OK, includes a variable that perhaps is a locale
new SimpleDateFormat('pattern', locale)
There is no point in creating a stateless Singleton because there is nothing within the class that needs guarding and no side effects to calling the constructor. Just create new instances of the object or write a Utility class with static methods. In the long term, Singletons can cause strong coupling and hard to change systems.
If the class has any fields at all, other than a self reference, then it is not considered stateless. A self reference is a field of the same type as the enclosing type, or a field named instance or _instance. The field name self reference is a property named instanceRegex that defaults to the value 'instance|_instance'
Example of violations:
@groovy.lang.Singleton
class Service {
// violation: the class has no fields but is marked Singleton
void processItem(item){
}
}
class Service {
// violation: the class has no fields other than 'instance' but is marked Singleton
static instance
void processItem(item){
}
}
class Service { // violation
static Service service
void processItem(item){
}
}
Checks for toString() methods that return null. This is unconventional and could cause unexpected NullPointerExceptions from normal or implicit use of toString().
Example of violations:
class MyClass {
String toString() {
if (foo()) {
return 'MyClass'
} else {
return null // violation
}
}
}
class MyClass {
String toString() {
calculateStuff()
null // violation
}
}
class MyClass {
String toString() { // violation - implicit return of null
}
}
Busy waiting (forcing a Thread.sleep() while waiting on a condition) should be avoided. Prefer using the gate and barrier objects in the java.util.concurrent package.
Example of violations:
while (x) { Thread.sleep(1000) }
while (x) { Thread.sleep(1000) { /* interruption handler */} }
for (int x = 10; x; x--) {
sleep(1000) // sleep is added to Object in Groovy
}
// here is the proper way to wait:
countDownLatch.await()
// this is weird code to write, but does not cause a violation
for (def x : collections) {
sleep(1000)
}
while (x) {
// you should use a lock here, but technically you are
// not just busy waiting because you are doing other work
doSomething()
sleep(1000)
}
This rule detects double checked locking, where a 'lock hint' is tested for null before initializing an object within a synchronized block. Double checked locking does not guarantee correctness and is an anti-pattern.
A full explanation of why double checked locking is broken in Java is available on Wikipedia:
Example of violations:
if (object == null) {
synchronized(this) {
if (object == null) {
// createObject() could be called twice depending
// on the Thread Scheduler.
object = createObject()
}
}
}
// there are several idioms to fix this problem.
def result = object;
if (result == null) {
synchronized(this) {
result = object;
if (result == null)
object = result = createObject()
}
}
// and a better solution for a singleton:
class myClass {
private static class ObjectHolder {
public static Object object = createObject()
}
public static Object getObject() {
return ObjectHolder.object;
}
}
Class contains similarly-named get and set methods where one method of the pair is marked either @WithReadLock or @WithWriteLock and the other is not locked at all. This may result in incorrect behavior at runtime, as callers of the get and set methods will not necessarily lock correctly and my see an inconsistent state for the object. The get and set method should both be guarded by @WithReadLock/@WithWriteLock or neither should be guarded.
Example of violations:
class Person {
String name
Date birthday
boolean deceased
boolean parent
@WithWriteLock setName(String name) {
this.name = name
}
// violation, get method should be locked
String getName() {
name
}
// violation, set method should be locked
void setBirthday(Date birthday) {
this.birthday = birthday
}
@WithReadLock String getBirthday() {
birthday
}
// violation, set method should be locked
void setDeceased(boolean deceased) {
this.deceased = deceased
}
@WithReadLock boolean isDeceased() {
deceased
}
@WithWriteLock void setParent(boolean parent) {
this.parent = parent
}
// violation, get method should be locked
boolean isParent() {
parent
}
}
Class contains similarly-named get and set methods where the set method is synchronized and the get method is not, or the get method is synchronized and the set method is not. This may result in incorrect behavior at runtime, as callers of the get and set methods will not necessarily see a consistent state for the object. The get and set method should both be synchronized or neither should be synchronized.
Example of violations:
class Person {
String name
Date birthday
boolean deceased
boolean parent
int weight
synchronized setName(String name) {
this.name = name
}
// violation, get method should be synchronized
String getName() {
name
}
// violation, set method should be synchronized
void setBirthday(Date birthday) {
this.birthday = birthday
}
synchronized String getBirthday() {
birthday
}
// violation, set method should be synchronized
void setDeceased(boolean deceased) {
this.deceased = deceased
}
synchronized boolean isDeceased() {
deceased
}
synchronized void setParent(boolean parent) {
this.parent = parent
}
// violation, get method should be synchronized
boolean isParent() {
parent
}
// violation get method should be synchronized
@groovy.transform.Synchronized
void setWeight(int value) {
weight = value
}
}
This rule reports occurrences of nested synchronized statements.
Nested synchronized statements should be avoided. Nested synchronized statements are either useless (if the lock objects are identical) or prone to deadlock.
Note that a closure or an anonymous inner class carries its own context (scope). A synchronized statement within a closure or an anonymous inner class defined within an outer synchronized statement does not cause a violation (though nested synchronized statements within either of those will).
Here is an example of code that produces a violation:
def myMethod() {
synchronized(this) {
// do something ...
synchronized(this) {
// do something else ...
}
}
}
Calendar objects should not be used as static fields. Calendars are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see random ArrayIndexOutOfBoundsException or IndexOutOfBoundsException in sun.util.calendar.BaseCalendar.getCalendarDateFromFixedDate(). You may also experience serialization problems. Using an instance field or a ThreadLocal is recommended.
For more information on this see Sun Bug #6231579 and Sun Bug #6178997.
Examples:
// Violations
class MyClass {
static Calendar calendar1
static java.util.Calendar calendar2
static final CAL1 = Calendar.getInstance()
static final CAL2 = Calendar.getInstance(Locale.FRANCE)
static def cal3 = Calendar.getInstance(timezone)
static Object cal4 = Calendar.getInstance(timezone, locale)
}
// These usages are OK
class MyCorrectClass {
private final Calendar calendar1
static ThreadLocal<Calendar> calendar2
}
Creates violations when a java.sql.Connection object is used as a static field. Database connections stored in static fields will be shared between threads, which is unsafe and can lead to race conditions.
A transactional resource object such as database connection can only be associated with one transaction at a time. For this reason, a connection should not be shared between threads and should not be stored in a static field. See Section 4.2.3 of the J2EE Specification for more details.
References:
Standards Mapping - Security Technical Implementation Guide Version 3 - (STIG 3) APP3630.1 CAT II
Standards Mapping - Common Weakness Enumeration - (CWE) CWE ID 362, CWE ID 567
Standards Mapping - SANS Top 25 2009 - (SANS 2009) Insecure Interaction - CWE ID 362
Standards Mapping - SANS Top 25 2010 - (SANS 2010) Insecure Interaction - CWE ID 362
Java 2 Platform Enterprise Edition Specification, v1.4 Sun Microsystems
DateFormat objects should not be used as static fields. DateFormats are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see random ArrayIndexOutOfBoundsException or IndexOutOfBoundsException in sun.util.calendar.BaseCalendar.getCalendarDateFromFixedDate(). You may also experience serialization problems. Using an instance field or a ThreadLocal is recommended.
For more information on this see Sun Bug #6231579 and Sun Bug #6178997.
Examples:
// Violations
class MyClass {
static DateFormat dateFormat1
static java.text.DateFormat dateFormat2
static final DATE1 = DateFormat.getDateInstance(DateFormat.LONG, Locale.FRANCE)
static final def DATE2 = DateFormat.getDateInstance(DateFormat.LONG)
static Object date3 = DateFormat.getDateInstance()
static final DATETIME1 = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.SHORT, Locale.FRANCE)
static final def DATETIME2 = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.SHORT)
static final Object DATETIME3 = DateFormat.getDateTimeInstance()
static final TIME1 = DateFormat.getTimeInstance(DateFormat.LONG, Locale.FRANCE)
static final def TIME2 = DateFormat.getTimeInstance(DateFormat.LONG)
static final Object TIME3 = DateFormat.getTimeInstance()
}
// These usages are OK
class MyCorrectClass {
private DateFormat calendar1
static ThreadLocal<DateFormat> calendar2
}
Matcher objects should not be used as static fields. Calendars are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
Example of violations:
// two violations
class MyClass {
static Matcher matcher1
static java.util.regex.Matcher matcher2
}
// these usages are OK
class MyCorrectClass {
private Matcher matcher1
static ThreadLocal<Matcher> matcher2
}
SimpleDateFormat objects should not be used as static fields. SimpleDateFormats are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see random ArrayIndexOutOfBoundsException or IndexOutOfBoundsException in sun.util.calendar.BaseCalendar.getCalendarDateFromFixedDate(). You may also experience serialization problems. Using an instance field or a ThreadLocal is recommended.
For more information on this see Sun Bug #6231579 and Sun Bug #6178997.
Examples:
// Violations
class MyClass {
static SimpleDateFormat dateFormat1
static java.text.SimpleDateFormat dateFormat2
static final DATE1 = new SimpleDateFormat()
static final DATE2 = new SimpleDateFormat('MM/dd')
static final DATE3 = new SimpleDateFormat('MM/dd', DateFormatSymbols.instance)
static date4 = new SimpleDateFormat('MM/dd', Locale.FRANCE)
static date5 = new java.text.SimpleDateFormat('MM/dd')
}
// These usages are OK
class MyCorrectClass {
private SimpleDateFormat calendar1
static ThreadLocal<SimpleDateFormat> calendar2
}
This rule reports uses of the synchronized keyword on methods. Synchronized methods are the same as synchronizing on 'this', which effectively make your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
Here is an example of code that produces a violation:
Checks for synchronization on getClass() rather than class literal. This instance method synchronizes on this.getClass(). If this class is subclassed, subclasses will synchronize on the class object for the subclass, which isn't likely what was intended.
The code synchronizes on a boxed primitive constant, such as an Integer. Since Integer objects can be cached and shared, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness and possible deadlock.
Example of violations:
class MyClass {
Byte byte1 = 100
Short short1 = 1
Double double1 = 1
Integer integer1 = 1
Long long1 = 1
Float float1 = 1
Character char1 = 1
byte byte2 = getValue()
short short2 = getValue()
double double2 = getValue()
int integer2 = getValue()
long long2 = getValue()
float float2 = getValue()
char char2 = getValue()
def byte3 = new Byte((byte)100)
def short3 = new Short((short)1)
def double3 = new Double((double)1)
def integer3 = new Integer(1)
def long3 = new Long(1)
def float3 = new Float(1)
def char3 = new Character((char)'1')
def byte4 = 1 as byte
def short4 = 1 as short
def double4 = 1 as double
def integer4 = 1 as int
def long4 = 1 as long
def float4 = 1 as float
def char4 = 1 as char
def byte5 = 1 as Byte
def short5 = 1 as Short
def double5 = 1 as Double
def integer5 = 1 as Integer
def long5 = 1 as Long
def float5 = 1 as Float
def char5 = 1 as Character
def byte6 = (byte)1
def short6 = (short)1
def double6 = (double)1
def integer6 = (int)1
def long6 = (long)1
def float6 = (float)1
def char6 = (char)1
def method() {
// all of these synchronization blocks produce violations
synchronized(byte1) {}
synchronized(short1) {}
synchronized(double1) {}
synchronized(integer1) {}
synchronized(long1) {}
synchronized(float1) {}
synchronized(char1) {}
synchronized(byte2) {}
synchronized(short2) {}
synchronized(double2) {}
synchronized(integer2) {}
synchronized(long2) {}
synchronized(float2) {}
synchronized(char2) {}
synchronized(byte3) {}
synchronized(short3) {}
synchronized(double3) {}
synchronized(integer3) {}
synchronized(long3) {}
synchronized(float3) {}
synchronized(char3) {}
synchronized(byte4) {}
synchronized(short4) {}
synchronized(double4) {}
synchronized(integer4) {}
synchronized(long4) {}
synchronized(float4) {}
synchronized(char4) {}
synchronized(byte5) {}
synchronized(short5) {}
synchronized(double5) {}
synchronized(integer5) {}
synchronized(long5) {}
synchronized(float5) {}
synchronized(char5) {}
synchronized(byte6) {}
synchronized(short6) {}
synchronized(double6) {}
synchronized(integer6) {}
synchronized(long6) {}
synchronized(float6) {}
synchronized(char6) {}
}
}
And here is an in-depth example of how it works within inner classes and such:
class MyClass {
final String lock = false
def method() {
// violation
synchronized(lock) { }
}
}
class MyClass {
final String lock = false
class MyInnerClass {
def method() {
// violation
synchronized(lock) { }
}
}
}
class MyClass {
// implicit typing
final def lock = true
def method() {
// violation
synchronized(lock) { }
}
}
class MyClass {
// implicit typing
final def lock = new Object[0] // correct idiom
def method() {
return new Runnable() {
final def lock = false // shadows parent from inner class
public void run() {
// violation
synchronized(stringLock) { }
}
}
}
}
class MyClass {
// implicit typing
final def lock = new Object[0] // correct idiom
class MyInnerClass {
final def lock = true // shadows parent from inner class
def method() {
// violation
synchronized(stringLock) { }
}
}
}
Synchronization on a String field can lead to deadlock. Constant Strings are interned and shared across all other classes loaded by the JVM. Thus, this could is locking on something that other code might also be locking. This could result in very strange and hard to diagnose blocking and deadlock behavior.
This rule reports uses of the synchronized blocks where the synchronization reference is 'this'. Doing this effectively makes your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
Here is an example of code that produces a violation:
Catches Serializable classes that define a synchronized readObject method. By definition, an object created by deserialization is only reachable by one thread, and thus there is no need for readObject() to be synchronized. If the readObject() method itself is causing the object to become visible to another thread, that is an example of very dubious coding style.
Examples:
class MyClass implements Serializable {
private synchronized void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {
// violation, no need to synchronized
}
}
class MyClass implements Serializable {
private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {
synchronized(lock) {
// violation, no need to synchronized
}
}
}
// OK, class not Serializable
class MyClass {
private synchronized void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException { }
}
// OK, class not Serializable
class MyClass {
private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {
synchronized(lock) { }
}
}
class MyClass implements Serializable {
private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {
// OK, this block is more than just a simple sync statement
synchronized(lock) { }
doSomething()
}
}
Synchronizing on a ReentrantLock field is almost never the intended usage. A ReentrantLock should be obtained using the lock() method and released in a finally block using the unlock() method.
import java.util.concurrent.locks.ReentrantLock;
final lock = new ReentrantLock();
def method() {
//Trying to enter the critical section
lock.lock(); // will wait until this thread gets the lock
try {
// critical section
} finally {
//releasing the lock so that other threads can get notifies
lock.unlock();
}
}
Example of violations:
class MyClass {
final ReentrantLock lock = new ReentrantLock()
def method() {
// violation
synchronized(lock) { }
}
}
class MyClass {
final ReentrantLock lock = new ReentrantLock()
class MyInnerClass {
def method() {
synchronized(lock) { }
}
}
}
class MyClass {
// implicit typing
final def lock = new ReentrantLock()
def method() {
// violation
synchronized(lock) { }
}
}
class MyClass {
// implicit typing
final def lock = new Object[0] // correct idiom
def method() {
return new Runnable() {
final def lock = new ReentrantLock() // shadows parent from inner class
public void run() {
// violation
synchronized(lock) { }
}
}
}
}
class MyClass {
// implicit typing
final def lock = new Object[0] // correct idiom
class MyInnerClass {
final def lock = new ReentrantLock() // shadows parent from inner class
def method() {
// violation
synchronized(lock) { }
}
}
}
This rule reports uses of the System.runFinalizersOnExit() method.
Method calls to System.runFinalizersOnExit() should not be allowed. This method is inherently non-thread-safe, may result in data corruption, deadlock, and may affect parts of the program far removed from it's call point. It is deprecated, and it's use strongly discouraged.
Here is an example of code that produces a violation:
class EventListener {
EventListener(EventPublisher publisher) {
publisher.register(this)
new WorkThread(publisher, this).start()
new AnotherWorkThread(listener: this)
}
}
This rule reports definition of the ThreadLocal fields that are not static and final.
ThreadLocal fields should be static and final. In the most common case a java.lang.ThreadLocal instance associates state with a thread. A non-static non-finaljava.lang.ThreadLocal field associates state with an instance-thread combination. This is seldom necessary and often a bug which can cause memory leaks and possibly incorrect behavior.
Here is an example of code that produces a violation:
private static ThreadLocal local1 = new ThreadLocal()
private final ThreadLocal local2 = new ThreadLocal()
protected ThreadLocal local3 = new ThreadLocal()
ThreadLocal local4 = new ThreadLocal()
This rule reports uses of the Thread.yield() method.
Method calls to Thread.yield() should not be allowed. This method has no useful guaranteed semantics, and is often used by inexperienced programmers to mask race conditions.
Here is an example of code that produces a violation:
Checks for code that calls notify() rather than notifyAll(). Java monitors are often used for multiple conditions. Calling notify() only wakes up one thread, meaning that the awakened thread might not be the one waiting for the condition that the caller just satisfied.
Volatile array fields are unsafe because the contents of the array are not treated as volatile. Changing the entire array reference is visible to other threads, but changing an array element is not.
This rule reports on long or double fields that are declared volatile.
Long or double fields should not be declared as volatile. Java specifies that reads and writes from such fields are atomic, but many JVM's have violated this specification. Unless you are certain of your JVM, it is better to synchronize access to such fields rather than declare them volatile. This rule flags fields marked volatile when their type is double or long or the name of their type is "Double" or "Long".
Here is an example of code that produces a violation:
def method() {
private volatile double d
private volatile long f
}
Calls to Object.wait() must be within a while loop. This ensures that the awaited condition has not already been satisfied by another thread before the wait() is invoked. It also ensures that the proper thread was resumed and guards against incorrect notification. See [1] and [3].
As a more modern and flexible alternative, consider using the Java concurrency utilities instead of wait() and notify(). See discussion in Effective Java [2].
Example of violation:
class MyClass {
private data
void processData()
synchronized(data) {
if (!data.isReady()) {
data.wait()
}
data.calculateStatistics()
}
}
}
Example of correct usage:
class MyClass {
private data
void processData()
synchronized(data) {
while (!data.isReady()) {
data.wait()
}
data.calculateStatistics()
}
}
}
References
[1] Effective Java, Programming Language Guide, by Joshua Bloch. Addison Wesley (2001). Chapter 50 (1st edition) is entitled "Never invoke wait outside a loop."
[2] Effective Java, 2nd edition, by Joshua Bloch, Addison Wesley (2008). Item #69: Prefer concurrency utilities to wait and notify.
Checks for array allocations that are not assigned or used, unless it is the last statement within a block (because it may be the intentional return value). Examples include:
int myMethod() {
new String[3] // unused
return -1
}
String[] myMethod() {
new String[3] // OK (last statement in block)
}
def closure = {
doStuff()
new Date[3] // unused
doOtherStuff()
}
def closure = { new Date[3] } // OK (last statement in block)
Checks for object allocations that are not assigned or used, unless it is the last statement within a block (because it may be the intentional return value). Examples include:
By default, this rule does not analyze test files. This rule sets the default value of the doNotApplyToFilesMatching property to ignore file names ending in 'Test.groovy', 'Tests.groovy' or 'TestCase.groovy'. Invoking constructors without using the result is a common pattern in tests.
int myMethod() {
new BigDecimal("23.45") // unused
return -1
}
BigDecimal myMethod() {
new BigDecimal("23.45") // OK (last statement in block)
}
def closure = {
doStuff()
new Date() // unused
doOtherStuff()
}
def closure = { new Date() } // OK (last statement in block)
Checks for private fields that are not referenced within the same class. Note that the private modifier is not currently "respected" by Groovy code (i.e., Groovy can access private members within other classes). By default, fields named serialVersionUID are ignored. The rule has a property named ignoreFieldNames, which can be set to ignore other field names as well. For instance, to ignore fields named 'fieldx', set the property to the 'fieldx, serialVersionUID'
Property
Description
Default Value
ignoreFieldNames
Specifies one or more (comma-separated) field names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
serialVersionUID
Known limitations:
Does not recognize field access when field name is a GString (e.g. this."$fieldName")
Does not recognize access of private field of another instance (i.e. other than this)
Checks for private methods that are not referenced within the same class. Note that the private modifier is not currently "respected" by Groovy code (i.e., Groovy can access private members within other classes).
Known limitations:
Does not recognize method reference through property access (e.g. getName() accessed as x.name)
Does not recognize method invocations when method name is a GString (e.g. this."$methodName"())
Does not recognize invoking private method of another instance (i.e. other than this)
Does not differentiate between multiple private methods with the same name but different parameters (i.e., overloaded)
Checks for parameters to private methods that are not referenced within the method body. Note that the private modifier is not currently "respected" by Groovy code (i.e., Groovy can access private members within other classes).
Known limitations:
Does not recognize parameter references within an inner class. See CodeNarc bug #3155974.
Does not recognize parameter references when parameter name is a GString (e.g. println "$parameterName")
Since CodeNarc 0.14 * You can specify an ignore list using the 'ignoreRegex' property. By default, a parameter named 'ignore' or 'ignored' does not trigger a violation (the regex value is 'ignore|ignored'). You can add your own ignore list using this property.
This rule finds instances of method parameters not being used. It does not analyze private methods (that is done by the UnusedPrivateMethodParameter rule) or methods marked @Override.
This rule ignores main() methods. In Groovy, the main()>> method can either specify a <<<void return type or else omit a return type (be dynamically typed). The main()>> method must have exactly one parameter. That parameter can either be typed as <<<String[] or else the type can be omitted (be dynamically typed). And the main()>> method must be <<<static.
You can specify an ignore list of parameter names using the 'ignoreRegex' property. By default, a parameter named 'ignore' or 'ignored' does not trigger a violation (the regex value is 'ignore|ignored'). You can add your own ignore list using this property.
You can specify a class name pattern to ignore using the 'ignoreClassRegex' property. By default classes named '*.Category' are ignored because they are category classes and have unused parameters in static methods.
Example of violations:
class MyClass {
def method(def param) {
// param is unused
}
}
Example of code that does not cause violations:
class MyClass {
@Override
def otherMethod(def param) {
// this is OK because it overrides a super class
}
}
class MyCategory {
// Category classes are ignored by default
void myMethod1(String string, int value) { }
void myMethod1(String string, int value, name) { }
}
class MainClass1 {
// main() methods are ignored
public static void main(String[] args) { }
}
class MainClass2 {
// This is also a valid Groovy main() method
static main(args) { }
}
The rule has a property named ignoreVariableNames, which can be set to ignore some variable names. For instance, to ignore fields named 'unused', set the property to 'unused'.
Property
Description
Default Value
ignoreVariableNames
Specifies one or more (comma-separated) variable names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
Known limitations:
Incorrectly considers a variable referenced if another variable with the same name is referenced elsewhere (in another scope/block).
CodeNarc-0.23/docs/codenarc-run-as-a-test.html 0000644 0001750 0001750 00000033152 12471222420 020436 0 ustar ebourg ebourg
CodeNarc - CodeNarc - Run as a Test
CodeNarc can be run as part of an automated test suite, for instance using JUnit or TestNG. This approach uses the org.codenarc.ant.CodeNarcTask class and Groovy's built-in support for Apache Ant.
NOTE: This approach may not play well with having CodeNarc also configured to run as part of your "regular" Ant build, especially if you have a classpath defined for your Ant build which is different that your runtime classpath for running your tests (which is likely).
Automated Test That Runs CodeNarc
This is an example JUnit test (JUnit 3.x) that runs CodeNarc.
private static final GROOVY_FILES = '**/*.groovy'
private static final RULESET_FILES = [
'rulesets/basic.xml',
'rulesets/imports.xml'].join(',')
void testRunCodeNarc() {
def ant = new AntBuilder()
ant.taskdef(name:'codenarc', classname:'org.codenarc.ant.CodeNarcTask')
ant.codenarc(ruleSetFiles:RULESET_FILES,
maxPriority1Violations:0, maxPriority2Violations:0) {
fileset(dir:'src/main/groovy') {
include(name:GROOVY_FILES)
}
fileset(dir:'src/test/groovy') {
include(name:GROOVY_FILES)
}
report(type:'ide')
}
}
Things to note:
This approach uses the AntBuilder class provided with Groovy.
The CodeNarc jar must be on the classpath. Any external resources that you reference must also be on the classpath, including any custom RuleSet files.
The maxPriority1Violations and maxPriority2Violations properties are configured to fail the test if any priority 1 or 2 violations are found.
An ide report is configured. This will to write (only) to standard out, and will include hyperlinks to the lines within the source code that contained the violations . The report shows the total number of violations (at each priority) and also list the violations by file.
See the CodeNarc Ant Task for more information on configuring the Ant task.
This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.
New in CodeNarc 0.14 Checks for static import statements which should never be after nonstatic imports.
This rule has one property comesBefore, which defaults to true. If you like your static imports to come after the others, then set this property to false.
Examples of violations:
import my.something.another
import static foo.bar
public class MyClass{}
Checks for an import from any package that is already automatically imported for Groovy files. 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.
Checks for import statements for classes that are never referenced within the source file. Also checks static imports.
Known limitations:
Does not check for unused imports containing wildcards (e.g. import org.codenarc.*)
Misses unused imports if the class/alias name is contained within strings, comments or other (longer) names (i.e., if that string shows up almost anywhere within the source code).
There is a codenarc.groovy command-line script in the root directory of the project. It is intended to streamline common development tasks. Currently, it supports a create-rule task for creating new CodeNarc rules.
codenarc create-rule
The create-rule task performs the following steps:
Prompt for the rule name
Prompt for the existing ruleset (category) name to which the rule is added
Create a new rule class file in the proper package (under src/main/groovy)
Create a new rule test class file (under src/test/groovy)
Add placeholder description messages for the new rule to "codenarc-base-messages.properties"
Add the new rule to the chosen ruleset XML file
RUNNING
On Unix/Mac, you can run the following from the project root directory:
./codenarc create-rule
On Windows, you can run:
codenarc create-rule.
(If Windows is not configured to automatically run *.groovy files, just can run groovy codenarc create-rule)
AFTER YOU RUNcodenarc create-rule
After you run codenarc create-rule, finish up the rule implementation, including the following:
Edit the generated rule class and associated test class to add the proper implementation.
Modify the description messages for the new rule in "codenarc-base-messages.properties". Move the message entries under the proper ruleset/category section within the file.
Add description to "src/main/site/apt/codenarc-rules-XX.apt" document in the site folder.
Run mvn site from the command-line. Make sure all of the tests pass and review the new rule description on the appropriate ruleset page on the project site.
Perform the following steps when creating a new rule. See The codenarc Command-line Script for information on the command-line script that automates a good bit of the boilerplate, as indicated below.
Implement the new Rule class. This is typically a subclass of AbstractAstVisitorRule. [1]
Implement the associated Rule test class. This is typically a subclass of AbstractRuleTestCase. [1]
Add the new rule class name to the appropriate RuleSet file under "src/main/resources/rulesets". [1]
Add the new rule description entries to "src/main/resources/codenarc-base-messages.properties". This includes both "RuleName.description" and "RuleName.description.html" property entries. [1]
Run LoadAllPredefinedRuleSetsTest.
Add a description of the new rule to the appropriate "src/main/site/apt/codenarc-rules-XX.apt" document.
Please do the following before submitting a patch or checking in code:
Run the full CodeNarc test suite. This includes a test called RunCodeNarcAgainstProjectSourceCodeTest that runs CodeNarc against its own source code (including any code that you have added or changed).
NOTES
[1] These files are created (skeletons) or updated automatically if you run the codenarc create-rule script to create the rule. See The codenarc Command-line Script
Static Analysis for Groovy: Less Bugs, Better Code
CodeNarc analyzes Groovy code for defects, bad practices, inconsistencies, style issues
and more. A flexible framework for rules, rulesets and custom rules means it's easy to configure CodeNarc
to fit into your project. Build tool, framework support, and report generation are all enterprise ready.
CodeNarc Web Console let's you play with the latest snapshot,
containing over 175 rules with more added each week.
Enter some text, click execute, and see the violations. Or run some scriptswemade.
CodeNarc triggers violations based on rules. Click the links to the left to view all the rules, such as
the basic, or concurrency
rules. Or you can create your own ruleset;
see how easy it is in this screencast.
A test method that invokes another test method is a chained test; the methods are dependent on one another. Tests should be isolated, and not be dependent on one another.
Example of violations:
class MyTest extends GroovyTestCase {
public void testFoo() {
// violations, calls test method on self
5.times { testBar() }
5.times { this.testBar() }
// OK, no violation: one arg method is not actually a test method
5.times { testBar(it) }
}
private static void assertSomething() {
testBar() // violation, even if in helper method
this.testBar() // violation, even if in helper method
}
public void testBar() {
// ...
}
}
This rule finds test cases that are coupled to other test cases, either by invoking static methods on another test case or by creating instances of another test case. If you require shared logic in test cases then extract that logic to a new class where it can properly be reused. Static references to methods on the current test class are ignored.
Example of violations:
class MyTest extends GroovyTestCase {
public void testMethod() {
// violation, static method call to other test
MyOtherTest.helperMethod()
// violation, instantiation of another test class
new MyOtherTest()
// no violation; same class
def input = MyTest.getResourceAsStream('sample.txt')
}
}
This rule checks for classes that import JUnit 4 classes and contain a public, instance, void, no-arg method named test* that is not annotated with the JUnit 4 @Test annotation.
Note: This rule should be disabled for Grails 2.x projects, since the Grails test framework can use AST Transformations to automatically annotate test methods.
This rule sets the default value of the applyToClassNames property to only match class names ending in 'Test', 'Tests' or 'TestCase'.
Rule that checks if a JUnit test class contains public methods other than standard test methods, JUnit framework methods or methods with JUnit annotations.
The following public methods are ignored by this rule:
Zero-argument methods with names starting with "test"
The setUp() and tearDown() methods
Methods annotated with @Test
Methods annotated with @Before and @After
Methods annotated with @BeforeClass and @AfterClass
Methods annotated with @Override
Public, non-test methods on a test class violate conventional usage of test classes, and they typically break encapsulation unnecessarily.
Public, non-test methods may also hide unintentional 'Lost Tests'. For instance, the test method declaration may (unintentionally) include methods parameters, and thus be ignored by JUnit. Or the method may (unintentionally) not follow the "test.." naming convention and not have the @Test annotation, and thus be ignored by JUnit.
This rule sets the default value of the applyToClassNames property to only match class names ending in 'Test', 'Tests' or 'TestCase'.
Checks for public properties defined on JUnit test classes. There is typically no need to expose a public property (with public getter and setter methods) on a test class.
This rule sets the default value of the applyToClassNames property to only match class names ending in 'Test', 'Tests' or 'TestCase'.
Property
Description
Default Value
ignorePropertyNames
Specifies one or more (comma-separated) property names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
Example of violations:
import org.junit.Test
class MyTestCase {
static String id // violation
def helper // violation
String name // violation
@Test
void testMe() { }
}
This rule detects calling JUnit style assertions like assertEquals, assertTrue, assertFalse, assertNull, assertNotNull. Groovy 1.7 ships with a feature called the "power assert", which is an assert statement with better error reporting. This is preferable to the JUnit assertions.
This rule searches for test methods that do not contain assert statements. Either the test method is missing assert statements, which is an error, or the test method contains custom assert statements that do not follow a proper assert naming convention. Test methods are defined as public void methods that begin with the work test or have a @Test annotation. By default this rule applies to the default test class names, but this can be changed using the rule's applyToClassNames property. An assertion is defined as either using the assert keyword or invoking a method that starts with the work assert, like assertEquals, assertNull, or assertMyClassIsSimilar. Also, any method named should.* also counts as an assertion so that shouldFail methods do not trigger an assertion, any method that starts with fail>> counts as an assertion, and any method that starts with <<<verify counts as an assertion. Since version 0.23 CodeNarc has support for JUnit's ExpectedException.
What counts as an assertion method can be overridden using the assertMethodPatterns property of the rule. The default value is this comma separated list of regular expressions:
If Spock's @IgnoreRest annotation appears on any method, all non-annotated test methods are not executed. This behaviour is almost always unintended. It's fine to use @IgnoreRest locally during development, but when committing code, it should be removed.
The specificationClassNames and specificationSuperclassNames properties determine which classes are considered Spock Specification classes.
Property
Description
Default Value
specificationClassNames
Specifies one or more (comma-separated) class names that should be treated as Spock Specification classes. The class names may optionally contain wildcards (*,?), e.g. "*Spec".
null
specificationSuperclassNames
Specifies one or more (comma-separated) class names that should be treated as Spock Specification superclasses. In other words, a class that extends a matching class name is considered a Spock Specification . The class names may optionally contain wildcards (*,?), e.g. "*Spec".
"*Specification"
Example of violations:
public class MySpec extends spock.lang.Specification {
@spock.lang.IgnoreRest
def "my first feature"() {
expect: false
}
def "my second feature"() {
given: def a = 2
when: a *= 2
then: a == 4
}
}
In a unit test, catching an exception and immediately calling Assert.fail() is pointless and hides the stack trace. It is better to rethrow the exception or not catch the exception at all.
This rule sets the default value of the applyToClassNames property to only match class names ending in 'Test', 'Tests' or 'TestCase'.
In unit tests, if a condition is expected to be false then there is no sense using assertTrue with the negation operator. For instance, assertTrue(!condition) can always be simplified to assertFalse(condition).
This rule sets the default value of the applyToClassNames property to only match class names ending in 'Test', 'Tests' or 'TestCase'.
This rule detects JUnit calling assertEquals where the first parameter is a boolean. These assertions should be made by more specific methods, like assertTrue or assertFalse.
This rule sets the default value of the applyToClassNames property to only match class names ending in 'Test', 'Tests' or 'TestCase'.
Property
Description
Default Value
checkAssertStatements
If true, then also check assert statements, e.g. assert x == true.
false
All of the following examples can be simplified to assertTrue or remove the true literal:
assertEquals(true, foo())
assertEquals("message", true, foo())
assertEquals(foo(), true)
assertEquals("message", foo(), true)
assertEquals(false, foo())
assertEquals("message", false, foo())
assertEquals(foo(), false)
assertEquals("message", foo(), false)
assert true == foo() // violation only if checkAssertStatements == true
assert foo() == true : "message" // violation only if checkAssertStatements == true
assert false == foo() // violation only if checkAssertStatements == true
assert foo() == false : "message" // violation only if checkAssertStatements == true
In unit tests, if a condition is expected to be true then there is no sense using assertFalse with the negation operator. For instance, assertFalse(!condition) can always be simplified to assertTrue(condition).
This rule sets the default value of the applyToClassNames property to only match class names ending in 'Test', 'Tests' or 'TestCase'.
This rule detects JUnit calling assertEquals where the first or second parameter is null. These assertion should be made against the assertNull method instead.
This rule sets the default value of the applyToClassNames property to only match class names ending in 'Test', 'Tests' or 'TestCase'.
This rule detects JUnit calling assertTrue or assertFalse where the first or second parameter is an Object#is() call testing for reference equality. These assertion should be made against the assertSame or assertNotSame method instead.
This rule sets the default value of the applyToClassNames property to only match class names ending in 'Test', 'Tests' or 'TestCase'.
You can configure rules within the RuleSet file or within the "codenarc.properties" file. Both of these approaches are described in the sections below.
NOTE: Keep in mind that RuleSet files can be nested (to any depth). That, along with the "codenarc.properties" file support, allows multiple layers of rule configuration. The hierarchical layering of configuration can come in handy within organizations comprised of multiple teams or projects. For instance, you can define an organization RuleSet file. Then each team can define its own RuleSet file and/or a "codenarc.properties" file, customizing the rules from the top-level file.
CodeNarc reads the properties file named "codenarc.properties", if found on the classpath, and applies the property values to any matching Rules. You can optionally override the location of the properties file by setting the "codenarc.properties.file" system property to the path or URL of the properties file. That can include a "file:" URL to load from a relative or absolute path on the filesystem (e.g., "file:relative/path/override-codenarc.properties"). If the properties file is not found, then do nothing.
For each properties entry of the form [rule-name].[property-name]=[property-value], the named property for the rule matching rule-name is set to the specified property-value. Properties entries not of this form or specifying rule names not within the current RuleSet are ignored.
The following example "codenarc.properties" file configures several rules. Note that Fields with Integer, String and Boolean values are configured.
# Sample RuleSet configuration
# Entries should be of the form: [rule-name].[property-name]=[property-value]
CatchThrowable.doNotApplyToClassNames=BaseController,AbstractTest
CatchThrowable.priority = 1
ReturnFromFinallyBlock.priority = 1
# Turn off this rule
AbstractClassName.enabled=false
# Unset special naming for final fields -- use base 'regex' value for all names
FieldName.finalRegex=
# Make sure all field names are prefixed with '_'
FieldName.regex=_[a-z][a-zA-Z0-9]*
Note that you cannot add new rules using the "codenarc.properties" file, though you can disable (turn off) rules.
The rules included with CodeNarc (as well as any subclasses of AbstractRule) provide several standard properties that can be used to configure how rules are applied to source files.
Applying Rules Based on Class Name and/or Package Name
The applyToClassNames and doNotApplyToClassNames properties enable filtering the classes to which the rule is applied.
If applyToClassNames is not empty or null, then the rule is only applied to classes matching one of the specified class names. Likewise, if doNotApplyToClassNames is not empty or null, then the rule is NOT applied to classes matching any of the specified class names.
Both of these properties can specify either a single class name or a comma-separated list of names. The names may optionally contain wildcard characters ('*' or '?'). The wildcard character '*' matches a sequence of zero or more characters in the input string. The wildcard character '?' matches exactly one character in the input string.
Each class name(s) can be either a fully-qualified class name (including the package) or else a class name without a package.
For instance, in the following example "codenarc.properties" excerpt, the CatchThrowable rule is NOT applied to classes named "BaseController" or "AbstractTest", no matter what package they are in (if any). The FieldName rule, on the other hand, is only applied to the org.codenarc.CodeNarc class or any of the classes within org.codenarc.extra package.
These properties are available only to subclasses of AbstractAstVisitorRule, but this includes almost all of the rules provided with CodeNarc -- i.e., all of the rules that deal with the Groovy AST (Abstract Syntax Tree) of a source file. This includes any rule that processes source code elements such as a package, class, method, field, parameter, etc..
Applying Rules Based on File Path or Name
Matching Either Filename or Pathname, With Optional Wildcards
The applyToFileNames and doNotApplyToFileNames properties enable filtering the files to which the rule is applied by specifying a comma-separated list of filenames (with optional path) of source files. If applyToFileNames is not empty or null, then the rule is only applied to source files matching one of the specified filenames. Likewise, if doNotApplyToFilesMatching is not empty or null, then the rule is NOT applied to source files matching any of the specified filenames.
Both properties may optionally specify a path (i.e., if the value contains at least one '/' path separator). In that case, the value is matched against the full pathname of each source file. If no path is specified, then only the filename of each source file is compared (i.e., its path is ignored).
Both properties may optionally contain wildcard characters ('*' or '?'). The wildcard character '*' matches a sequence of zero or more characters in the input string. The wildcard character '?' matches exactly one character in the input string. Both properties default to null.
Matching File Pathnames Against a Regular Expression
The applyToFilesMatching and doNotApplyToFilesMatching properties enable filtering the files to which the rule is applied by matching a regular expression against the full pathname of each source file. If applyToFilesMatching is not empty or null, then the rule is only applied to source files with matching paths. Likewise, if doNotApplyToFilesMatching is not empty or null, then the rule is NOT applied to source files with matching paths. Both properties default to null.
NOTE: File separator characters within pathnames are normalized to forward slashes (/). On Windows, for instance, that means that the path "c:\dir\file.txt" is normalized to "c:/dir/file.txt". If your regular expressions contain file separator characters, be sure that they are all the standard '/', no matter what operating system.
Other Standard Rule Properties
The enabled boolean property allows a rule to be completely turned off (by setting it to false). It defaults to true.
The violationMessage property enables overriding the rule violation message. If not null, this is used as the message for all violations of this rule, overriding any message generated by the rule itself. This property defaults to null. Note that setting this to an empty string "hides" the message, if any, generated by the actual rule.
The description property enables overriding the rule description text. If not null, this value is used as the description text for this rule, overriding any description text found in the i18n resource bundles. This property defaults to null. Also see Include Substitutable Message Parameters in a Rule Description
You can also override the default name or priority properties for each rule.
Alternately, as mentioned above, you can turn off (disable) a rule by setting its enabled boolean property to false (assuming it is a subclass of AbstractRule), as shown in the following "codenarc.properties" excerpt.
# Turn off this rule
AbstractClassName.enabled=false
And here is an example of disabling a rule within a Groovy RuleSet by setting its enabled attribute to false.
You can use the @SuppressWarnings annotation on a class, method, constructor, field or property to suppress one or more CodeNarc rules within its source code.
Specify one or more rule name as the parameter of the @SuppressWarnings annotation. Note that this is the rule name, not the class name (i.e., without the "Rule" suffix). Specify multiple rule names by passing a List of rule names as a single parameter, e.g. @SuppressWarnings(['IfStatementBraces', 'ThrowException'])
NOTE: The @SuppressWarnings annotation only works for rule classes that subclass AbstractAstVisitorRule.
For example, the following code suppresses (prevents) violations of the DuplicateStringLiteral rule within the MyClass class, as well as suppressing the IfStatementBraces and ThrowException rules within its getCount() method.
@SuppressWarnings('DuplicateStringLiteral')
class MyClass {
def y = 'x'
def z = 'x'
@SuppressWarnings(['IfStatementBraces', 'ThrowException'])
int getCount() {
if (!ready) throw new Exception('Not ready')
}
}
The descriptions for rules used in a CodeNarc report are shown at the bottom of the resulting HTML report. Those rule descriptions are retrieved from a ResourceBundle. This ResourceBundle consists of a base (parent) bundle, provided with the CodeNarc distribution, and an optional custom (child) bundle, which may be provided by the user.
Because this is based on the standard Java ResourceBundle facility, you can customize (override) or translate these descriptions by providing your own locale-specific message properties file on the classpath. For example, a German one would be named "codenarc-messages_de.properties".
The rule description message key is of the form "<rule-name>.description.html". Examples include "BooleanInstantiation.description.html" and "CatchThrowable.description.html".
(Note that the rule description included in the XML report is specified by the key <rule-name>.description).
See the javadoc for the java.util.ResourceBundle class for more information.
You can optionally include message parameters within a rule description, whether that description is specified in a ResourceBundle properties file or through the description property of the rule. Use the standard Groovy template parameter syntax: ${..}. You can reference rule property values through the "rule" object within the template parameter closure. For example, this description includes the rule priority within the rule description: "Description for rule with priority ${rule.priority}".
The Base Messages Resource Bundle
The base ResourceBundle provided with the CodeNarc distribution has a basename of "codenarc-base-messages". The rules provided with CodeNarc all have associated descriptions within the "codenarc-base-messages.properties" file.
You can provide a locale-specific variant of this file on the classpath if you wish, but in most scenarios, the recommended approach for customizing rule descriptions is to provide a custom messages bundle file, as described below.
The Custom Messages Resource Bundle
You can optionally provide descriptions for new rules or override existing rule descriptions by placing a "codenarc-messages.properties" file on the classpath. This is also a ResourceBundle file, so it can have locale-specific variants, if needed. If this bundle (file) is present, it is searched first. If the desired message key is not found, only then is the base message bundle checked.
You can provide rule description entries within this file for custom rules that you create. You can also include rule description entries for existing rules, in which case the descriptions in this file override the default descriptions.
Customizing the Name and Description for an Existing Rule
You may wish to customize both the name and the description for an existing rule. For example, you may want to have multiple instances of a generic rule, each configured differently. Or you may just want to make the rule name more clearly denote its specific purpose.
For example, in the following excerpt from a RuleSet file, because the name property is customized for the IllegalRegexRule, the new rule name "AuthorTagNotAllowed" will show up at the bottom of the HTML report, instead of the default rule name "IllegalRegex".
The rule description must be added to the custom messages resource bundle file ("codenarc-messages.properties"). The message key will be "AuthorTagNotAllowed.description.html" to set the description used in the HTML report, and "AuthorTagNotAllowed.description" for the description used in the XML report.
Checks for classes containing fields/properties/methods matching configured illegal member modifiers or not matching any of the configured allowed member modifiers.
Property
Description
Default Value
allowedFieldModifiers
Specifies one or more groups of whitespace-delimited modifier names (e.g. "public static" or "protected"). Multiple groups are separated by commas (e.g. "private final, protected"). If a field does not match all of the modifiers in any group, then trigger a violation. If null or empty, skip this check.
null
allowedMethodModifiers
Specifies one or more groups of whitespace-delimited modifier names (e.g. "public static" or "protected"). Multiple groups are separated by commas (e.g. "private final, protected"). If a method does not match all of the modifiers in any group, then trigger a violation. If null or empty, skip this check.
null
allowedPropertyModifiers
Specifies one or more groups of whitespace-delimited modifier names (e.g. "public static" or "protected"). Multiple groups are separated by commas (e.g. "private final, protected"). If a property does not match all of the modifiers in any group, then trigger a violation. If null or empty, skip this check.
null
ignoreMethodNames
Specifies one or more (comma-separated) method names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
ignoreMethodsWith- AnnotationNames
Specifies one or more (comma-separated) annotation names that should be ignored (i.e., methods with those annotations should not cause a rule violation). The names may optionally contain wildcards (*,?). (Do not include the "@" in the annotation name.
null
illegalFieldModifiers
Specifies one or more groups of whitespace-delimited modifier names (e.g. "public static" or "protected"). Multiple groups are separated by commas (e.g. "private final, protected"). If a field matches all of the modifiers in any group, then trigger a violation. If null or empty, skip this check.
null
illegalMethodModifiers
Specifies one or more groups of whitespace-delimited modifier names (e.g. "public static" or "protected"). Multiple groups are separated by commas (e.g. "private final, protected"). If a method matches all of the modifiers in any group, then trigger a violation. If null or empty, skip this check.
null
illegalPropertyModifiers
Specifies one or more groups of whitespace-delimited modifier names (e.g. "public static" or "protected"). Multiple groups are separated by commas (e.g. "private final, protected"). If a property matches all of the modifiers in any group, then trigger a violation. If null or empty, skip this check.
null
Modifiers for fields and methods include:
public
protected
private
static
final
volatile (fields only)
transient (fields only)
Modifiers for properties are only:
static
final
Note that you must use the standard rule properties, such as applyToClassNames, doNotApplyToFileNames and applyToFilesMatching to apply this rule to a subset of all classes/files. These rule properties are described in Standard Properties for Configuring Rules.
// IllegalClassMember.illegalPropertyModifiers = 'final'
class MyClass {
def property1
final property2 // violation
static property3
}
A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and classNames, and (optionally) customized violationMessage and priority.
Notes
At least one the illegalFieldModifiers, allowedFieldModifiers, illegalPropertyModifiers, allowedPropertyModifiers, illegalMethodModifiers or allowedMethodModifiers properties must be set (i.e., not null or empty) or else this rule does nothing. In other words, you must configure this rule with at least one kind of illegal or allowed class member.
At least one of the (standard) applyToClassNames, applyToFileNames or applyToFilesMatching properties must be set (i.e., not null or empty) or else this rule does nothing. In other words, you must configure this rule to apply to a specific set of classes or files.
Checks for reference to any of the classes configured in classNames.
Property
Description
Default Value
classNames
Specifies the comma-separated list of (fully-qualified) class names. The class name(s) may optionally include wildcard characters ('*' or '?'). Note that the '*' wildcard matches any sequence of zero or more characters in the class/package name, e.g. 'a.*.MyClass' matches a.b.MyClass as well as a.b.c.d.MyClass. If classNames is null or empty, do nothing.
null
Note that you can use the standard rule properties, such as applyToClassNames, doNotApplyToFileNames and applyToFilesMatching to only apply this rule to a subset of all classes/files. These rule properties are described in Standard Properties for Configuring Rules.
This rule can be useful for governance and enforcement of architectural layering. For instance, making sure that view or model classes, for instance, do not contain references to DAO classes (e.g., *Dao).
Here is an example configuration of this rule used to ensure that DAO classes are not referenced from within model classes:
ruleset {
description "Example CodeNarc Ruleset"
// ...
IllegalClassReference {
name = 'DoNotReferenceDaoFromModelClasses'
priority = 2
classNames = '*Dao'
applyToClassNames = 'com.example.model.*'
description = 'Do not reference DAOs from model classes.'
}
}
A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and classNames, and (optionally) customized violationMessage and priority.
Checks for reference to any of the packages configured in packageNames.
Property
Description
Default Value
packageNames
Specifies the comma-separated list of package names. The package name(s) may optionally include wildcard characters ('*' or '?'). Note that the '*' wildcard matches any sequence of zero or more characters in the package name, e.g. 'a.*' matches 'a.b' as well as 'a.b.c.d'. If packageNames is null or empty, do nothing.
null
Note that you can use the standard rule properties, such as applyToClassNames, doNotApplyToFileNames and applyToFilesMatching to only apply this rule to a subset of all classes/files. These rule properties are described in Standard Properties for Configuring Rules.
This rule can be useful for governance and enforcement of architectural layering. For instance, making sure that view or model classes, for instance, do not contain references to JDBC-specific packages (e.g. java.sql and javax.sql).
Here is an example configuration of this rule used to ensure that JDBC packages/classes are only referenced within DAO classes:
ruleset {
description "Example CodeNarc Ruleset"
// ...
IllegalPackageReference {
name = 'UseJdbcOnlyInDaoClasses'
priority = 2
packageNames = 'groovy.sql, java.sql, javax.sql'
doNotApplyToClassNames = 'com.example.framework.dao.*, *Dao, *DaoImpl'
description = 'Reference to JDBC packages should be restricted to DAO classes.'
}
}
A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and packageNames, and (optionally) customized violationMessage and priority.
Checks for a specified illegal regular expression within the source code.
Property
Description
Default Value
regex
The regular expression to check for. If null or empty then do nothing.
null
A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and regex, and (optionally) customized violationMessage and priority.
NOTE: This rule applies to the text contents of an entire file rather than a specific class, so it does not support the applyToClassNames and doNotApplyToClassNames configuration properties.
Checks for a specified illegal string within the source code.
Property
Description
Default Value
string
The String to check for. If null or empty then do nothing.
null
A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and string, and (optionally) customized violationMessage and priority.
NOTE: This rule applies to the text contents of an entire file rather than a specific class, so it does not support the applyToClassNames and doNotApplyToClassNames configuration properties.
Checks for classes that extend one of the specified set of illegal superclasses.
Property
Description
Default Value
superclassNames
Specifies the comma-separated list of (fully-qualified) class names. The class name(s) may optionally include wildcard characters ('*' or '?'). Note that the '*' wildcard matches any sequence of zero or more characters in the class/package name, e.g. 'a.*.MyClass' matches a.b.MyClass as well as a.b.c.d.MyClass. If classNames is null or empty, do nothing.
null
A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and string, and (optionally) customized violationMessage and priority.
Checks for a specified regular expression that must exist within the source code.
Property
Description
Default Value
regex
The regular expression to check for. If null or empty then do nothing.
null
A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and regex, and (optionally) customized violationMessage and priority.
NOTE: This rule applies to the text contents of an entire file rather than a specific class, so it does not support the applyToClassNames and doNotApplyToClassNames configuration properties.
Checks for a specified text string that must exist within the source code.
Property
Description
Default Value
string
The String to check for. If null or empty then do nothing.
null
A RuleSet can contain any number of instances of this rule, but each should be configured with a unique rule name and string, and (optionally) customized violationMessage and priority.
NOTE: This rule applies to the text contents of an entire file rather than a specific class, so it does not support the applyToClassNames and doNotApplyToClassNames configuration properties.
Checks for non-final fields on a class. The intent of this rule is to check a configured set of classes that should remain "stateless" and reentrant. One example might be Grails service classes which are singletons, by default, and so they should be reentrant.
This rule ignores final fields (either instance or static). Fields that are static and non-final, however, do cause a violation.
This rule also ignores all fields annotated with the @Inject annotation.
You can configure this rule to ignore certain fields either by name or by type. This can be useful to ignore fields that hold references to (static) dependencies (such as DAOs or Service objects) or static configuration.
Property
Description
Default Value
ignoreFieldNames
Specifies one or more (comma-separated) field names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
addToIgnoreFieldNames
Specifies one or more (comma-separated) field names to be added to the ignoreFieldNames property value. This is a special write-only property, and each call to setAddIgnoreFieldNames() adds to (rather than overwrites) the list of field names to be ignored.
null
ignoreFieldTypes
Specifies one or more (comma-separated) field types that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).
null
Note that you can use the standard rule properties, such as applyToClassNames, doNotApplyToFileNames and applyToFilesMatching to only apply this rule to a subset of all classes/files. These rule properties are described in Standard Properties for Configuring Rules.
Notes
The ignoreFieldTypes property matches the field type name as indicated in the field declaration, only including a full package specification IF it is included in the source code. For example, the field declaration BigDecimal value matches an ignoreFieldTypes value of BigDecimal, but not java.lang.BigDecimal.
There is one exception for the ignoreFieldTypes property: if the field is declared with a modifier/type of def, then the type resolves to java.lang.Object.
At least one of the (standard) applyToClassNames, applyToFileNames or applyToFilesMatching properties must be set (i.e., not null or empty) or else this rule does nothing. In other words, you must configure this rule to apply to a specific set of classes or files.
This rule will not catch violations of true statelessness/reentrancy if you define a final field whose value is itself mutable, e.g. a final HashMap.
The CodeNarc Ant Task is implemented by the org.codenarc.ant.CodeNarcTask class.
Parameters
Attribute
Description
Required
ruleSetFiles
The paths to the Groovy or XML RuleSet definition files. This can be a single file path, or multiple paths separated by commas. By default, the paths specified are relative to the classpath. But each path may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute filesystem path), or "http:".
YES
maxPriority1Violations
The maximum number of priority 1 violations allowed before failing the build (throwing a BuildException).
NO
maxPriority2Violations
The maximum number of priority 2 violations allowed before failing the build (throwing a BuildException).
NO
maxPriority3Violations
The maximum number of priority 3 violations allowed before failing the build (throwing a BuildException).
NO
Report Nested Element
The report nested element defines the format and output file for the analysis report.
Attribute
Description
Required
type
The type of the output report. Must be either one of the predefined type names: "html", "xml", "text", "console", "ide" or else the fully-qualified class name of a class (accessible on the classpath) that implements the org.codenarc.report.ReportWriter interface.
Yes
toFile (Deprecated)
The path and filename for the output report file. This is deprecated. Use the <option> nested element instead.
No
title (Deprecated)
The title for the output report. This is deprecated. Use the <option> nested element instead.
No
Notes:
The "ide" report type creates an IdeTextReportWriter and sets its writeToStandardOut property to true. The generated report includes IDE-compatible (Eclipse, Idea) hyperlinks to source code for violations.
The "console" report type creates a TextReportWriter and sets its writeToStandardOut property to true.
Option Nested Element
The <option> element is a child of the <report> element and defines a report-specific option for a report. You specify the option name> and <<value as attributes within the <option> element. See the Example below.
Fileset Nested Element
At least one fileset nested element is required, and is used to specify the source files that CodeNarc should analyze. This is the standard Ant FileSet, and is quite powerful and flexible. See the Apache Ant Manual for more information on FileSets.
The following document contains the results of PMD's CPD 5.1.2.
Duplications
File
Line
org\codenarc\rule\AbstractFieldVisitor.java
110
org\codenarc\rule\AbstractMethodVisitor.java
138
}
@Override
protected final void visitObjectInitializerStatements(ClassNode node) {
throw new UnsupportedOperationException();
}
@Override
protected final SourceUnit getSourceUnit() {
throw new RuntimeException("should never be called");
}
@Override
public final void visitPackage(PackageNode node) {
throw new UnsupportedOperationException();
}
@Override
public final void visitImports(ModuleNode node) {
throw new UnsupportedOperationException();
}
@Override
public final void visitAnnotations(AnnotatedNode node) {
throw new UnsupportedOperationException();
}
@Override
protected final void visitClassCodeContainer(Statement code) {
throw new UnsupportedOperationException();
}
@Override
public final void visitVariableExpression(VariableExpression expression) {
throw new UnsupportedOperationException();
}
@Override
protected final void visitConstructorOrMethod(MethodNode node, boolean isConstructor) {
throw new UnsupportedOperationException();
}
@Override
public final void visitConstructor(ConstructorNode node) {
throw new UnsupportedOperationException();
}
@Override
public final void visitProperty(PropertyNode node) {
throw new UnsupportedOperationException();
}
@Override
protected final void addError(String msg, ASTNode expr) {
super.addError(msg, expr);
}
@Override
protected final void visitStatement(Statement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitAssertStatement(AssertStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitBlockStatement(BlockStatement block) {
throw new UnsupportedOperationException();
}
@Override
public final void visitBreakStatement(BreakStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitCaseStatement(CaseStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitCatchStatement(CatchStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitContinueStatement(ContinueStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitDoWhileLoop(DoWhileStatement loop) {
throw new UnsupportedOperationException();
}
@Override
public final void visitExpressionStatement(ExpressionStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitForLoop(ForStatement forLoop) {
throw new UnsupportedOperationException();
}
@Override
public final void visitIfElse(IfStatement ifElse) {
throw new UnsupportedOperationException();
}
@Override
public final void visitReturnStatement(ReturnStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitSwitch(SwitchStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitSynchronizedStatement(SynchronizedStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitThrowStatement(ThrowStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitTryCatchFinally(TryCatchStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitWhileLoop(WhileStatement loop) {
throw new UnsupportedOperationException();
}
@Override
protected final void visitEmptyStatement(EmptyStatement statement) {
throw new UnsupportedOperationException();
}
@Override
public final void visitMethodCallExpression(MethodCallExpression call) {
throw new UnsupportedOperationException();
}
@Override
public final void visitStaticMethodCallExpression(StaticMethodCallExpression call) {
throw new UnsupportedOperationException();
}
@Override
public final void visitConstructorCallExpression(ConstructorCallExpression call) {
throw new UnsupportedOperationException();
}
@Override
public final void visitBinaryExpression(BinaryExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitTernaryExpression(TernaryExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitShortTernaryExpression(ElvisOperatorExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitPostfixExpression(PostfixExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitPrefixExpression(PrefixExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitBooleanExpression(BooleanExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitNotExpression(NotExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitClosureExpression(ClosureExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitTupleExpression(TupleExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitListExpression(ListExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitArrayExpression(ArrayExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitMapExpression(MapExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitMapEntryExpression(MapEntryExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitRangeExpression(RangeExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitSpreadExpression(SpreadExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitSpreadMapExpression(SpreadMapExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitMethodPointerExpression(MethodPointerExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitUnaryMinusExpression(UnaryMinusExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitUnaryPlusExpression(UnaryPlusExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitBitwiseNegationExpression(BitwiseNegationExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitCastExpression(CastExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitConstantExpression(ConstantExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitClassExpression(ClassExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitDeclarationExpression(DeclarationExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitPropertyExpression(PropertyExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitAttributeExpression(AttributeExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitFieldExpression(FieldExpression expression) {
throw new UnsupportedOperationException();
}
@Override
public final void visitGStringExpression(GStringExpression expression) {
throw new UnsupportedOperationException();
}
@Override
protected final void visitListOfExpressions(List<? extends Expression> list) {
throw new UnsupportedOperationException();
}
@Override
public final void visitArgumentlistExpression(ArgumentListExpression ale) {
throw new UnsupportedOperationException();
}
@Override
public final void visitClosureListExpression(ClosureListExpression cle) {
throw new UnsupportedOperationException();
}
@Override
public final void visitBytecodeExpression(BytecodeExpression cle) {
throw new UnsupportedOperationException();
}
@Override
public final void visitMethod(MethodNode node) {
Grails (and possibly other tools integrating with CodeNarc) can benefit from using the current thread context ClassLoader for loading rule script files, rather than the default base ClassLoader. Setting the "codenarc.useCurrentThreadContextClassLoader" system property to "true" uses the current thread context ClassLoader for loading rule script files. That enables Grails to load rule script files from within the Grails project, and allows those rule scripts to reference local classes. See GPCODENARC-32. The Grails CodeNarc Plugin automatically sets that system property.
The J2EE standard requires that applications use the container's resource management facilities to obtain connections to resources. Every major web application container provides pooled database connection management as part of its resource management framework. Duplicating this functionality in an application is difficult and error prone, which is part of the reason it is forbidden under the J2EE standard.
Note: If a violation is triggered from an import statement, then you may get multiple violations per import if there are multiple classes in the source file. In that case, the imports are processed once per class.
Note: If a violation is triggered from an import statement, then you may get multiple violations per import if there are multiple classes in the source file. In that case, the imports are processed once per class.
Checks for direct use of java.sql.Statement, java.sql.PreparedStatement, or java.sql.CallableStatement, which is not necessary if using the Groovy Sql facility or an ORM framework such as Hibernate.
Note: If a violation is triggered from an import statement, then you may get multiple violations per import if there are multiple classes in the source file. In that case, the imports are processed once per class.
Checks for instantiating a logger for a class other than the current class. Checks for logger instantiations for Log4J, SLF4J, Logback, Apache Commons Logging and Java Logging API (java.util.logging).
This rule contains a parameter allowDerivedClasses. When set, a logger may be created about this.getClass().
Limitations:
Only checks Loggers instantiated within a class field or property (not variables or expressions within a method)
For Log4J: Does not catch Logger instantiations if you specify the full package name for the Logger class: e.g. org.apache.log4.Logger.getLogger(..)
For SLF4J and Logback: Does not catch Log instantiations if you specify the full package name for the LoggerFactory class: e.g. org.slf4j.LoggerFactory.getLogger(..)
For Commons Logging: Does not catch Log instantiations if you specify the full package name for the LogFactory class: e.g. org.apache.commons.logging.LogFactory.getLog(..)
For Java Logging API: Does not catch Logger instantiations if you specify the full package name for the Logger class: e.g. java.util.logging.Logger.getLogger(..)
Here are examples of Log4J or Java Logging API code that cause violations:
If you are logging an exception then the proper API is to call error(Object, Throwable), which will log the message and the exception stack trace. If you call error(Object) then the stacktrace may not be logged.
Logger objects should be declared private, static and final.
This rule has a property: allowProtectedLogger, which defaults to false. Set it to true if you believe subclasses should have access to a Logger in a parent class and that Logger should be declared protected or public.
This rule has a property: allowNonStaticLogger, which defaults to false. Set it to true if you believe a logger should be allowed to be non-static.
Checks for calls to Throwable.printStackTrace() or StackTraceUtils.printSanitizedStackTrace(Throwable). Consider using a standard logging facility instead.
Checks for calls to System.out.print(), System.out.println() or System.out.printf(). Consider using a standard logging facility instead.
CodeNarc-0.23/docs/css/ 0000755 0001750 0001750 00000000000 12623571301 014164 5 ustar ebourg ebourg CodeNarc-0.23/docs/css/maven-theme.css 0000644 0001750 0001750 00000005361 12471222451 017111 0 ustar ebourg ebourg body {
padding: 0px 0px 10px 0px;
}
body, td, select, input, li{
font-family: Verdana, Helvetica, Arial, sans-serif;
font-size: 13px;
}
code{
font-family: Courier, monospace;
font-size: 13px;
}
a {
text-decoration: none;
}
a:link {
color:#36a;
}
a:visited {
color:#47a;
}
a:active, a:hover {
color:#69c;
}
#legend li.externalLink {
background: url(../images/external.png) left top no-repeat;
padding-left: 18px;
}
a.externalLink, a.externalLink:link, a.externalLink:visited, a.externalLink:active, a.externalLink:hover {
background: url(../images/external.png) right center no-repeat;
padding-right: 18px;
}
#legend li.newWindow {
background: url(../images/newwindow.png) left top no-repeat;
padding-left: 18px;
}
a.newWindow, a.newWindow:link, a.newWindow:visited, a.newWindow:active, a.newWindow:hover {
background: url(../images/newwindow.png) right center no-repeat;
padding-right: 18px;
}
h2 {
padding: 4px 4px 4px 6px;
border: 1px solid #999;
color: #900;
background-color: #ddd;
font-weight:900;
font-size: x-large;
}
h3 {
padding: 4px 4px 4px 6px;
border: 1px solid #aaa;
color: #900;
background-color: #eee;
font-weight: normal;
font-size: large;
}
h4 {
padding: 4px 4px 4px 6px;
border: 1px solid #bbb;
color: #900;
background-color: #fff;
font-weight: normal;
font-size: large;
}
h5 {
padding: 4px 4px 4px 6px;
color: #900;
font-size: normal;
}
p {
line-height: 1.3em;
font-size: small;
}
#breadcrumbs {
border-top: 1px solid #aaa;
border-bottom: 1px solid #aaa;
background-color: #ccc;
}
#leftColumn {
margin: 10px 0 0 5px;
border: 1px solid #999;
background-color: #eee;
}
#navcolumn h5 {
font-size: smaller;
border-bottom: 1px solid #aaaaaa;
padding-top: 2px;
color: #000;
}
table.bodyTable th {
color: white;
background-color: #bbb;
text-align: left;
font-weight: bold;
}
table.bodyTable th, table.bodyTable td {
font-size: 1em;
}
table.bodyTable tr.a {
background-color: #ddd;
}
table.bodyTable tr.b {
background-color: #eee;
}
.source {
border: 1px solid #999;
}
dl {
padding: 4px 4px 4px 6px;
border: 1px solid #aaa;
background-color: #ffc;
}
dt {
color: #900;
}
#organizationLogo img, #projectLogo img, #projectLogo span{
margin: 8px;
}
#banner {
border-bottom: 1px solid #fff;
}
.errormark, .warningmark, .donemark, .infomark {
background: url(../images/icon_error_sml.gif) no-repeat;
}
.warningmark {
background-image: url(../images/icon_warning_sml.gif);
}
.donemark {
background-image: url(../images/icon_success_sml.gif);
}
.infomark {
background-image: url(../images/icon_info_sml.gif);
}
CodeNarc-0.23/docs/css/print.css 0000644 0001750 0001750 00000000327 12471222451 016034 0 ustar ebourg ebourg #banner, #footer, #leftcol, #breadcrumbs, .docs #toc, .docs .courtesylinks, #leftColumn, #navColumn {
display: none !important;
}
#bodyColumn, body.docs div.docs {
margin: 0 !important;
border: none !important
}
CodeNarc-0.23/docs/css/maven-base.css 0000644 0001750 0001750 00000004507 12471222451 016722 0 ustar ebourg ebourg body {
margin: 0px;
padding: 0px;
}
img {
border:none;
}
table {
padding:0px;
width: 100%;
margin-left: -2px;
margin-right: -2px;
}
acronym {
cursor: help;
border-bottom: 1px dotted #feb;
}
table.bodyTable th, table.bodyTable td {
padding: 2px 4px 2px 4px;
vertical-align: top;
}
div.clear{
clear:both;
visibility: hidden;
}
div.clear hr{
display: none;
}
#bannerLeft, #bannerRight {
font-size: xx-large;
font-weight: bold;
}
#bannerLeft img, #bannerRight img {
margin: 0px;
}
.xleft, #bannerLeft img {
float:left;
}
.xright, #bannerRight {
float:right;
}
#banner {
padding: 0px;
}
#banner img {
border: none;
}
#breadcrumbs {
padding: 3px 10px 3px 10px;
}
#leftColumn {
width: 170px;
float:left;
overflow: auto;
}
#bodyColumn {
margin-right: 1.5em;
margin-left: 197px;
}
#legend {
padding: 8px 0 8px 0;
}
#navcolumn {
padding: 8px 4px 0 8px;
}
#navcolumn h5 {
margin: 0;
padding: 0;
font-size: small;
}
#navcolumn ul {
margin: 0;
padding: 0;
font-size: small;
}
#navcolumn li {
list-style-type: none;
background-image: none;
background-repeat: no-repeat;
background-position: 0 0.4em;
padding-left: 16px;
list-style-position: outside;
line-height: 1.2em;
font-size: smaller;
}
#navcolumn li.expanded {
background-image: url(../images/expanded.gif);
}
#navcolumn li.collapsed {
background-image: url(../images/collapsed.gif);
}
#navcolumn li.none {
text-indent: -1em;
margin-left: 1em;
}
#poweredBy {
text-align: center;
}
#navcolumn img {
margin-top: 10px;
margin-bottom: 3px;
}
#poweredBy img {
display:block;
margin: 20px 0 20px 17px;
}
#search img {
margin: 0px;
display: block;
}
#search #q, #search #btnG {
border: 1px solid #999;
margin-bottom:10px;
}
#search form {
margin: 0px;
}
#lastPublished {
font-size: x-small;
}
.navSection {
margin-bottom: 2px;
padding: 8px;
}
.navSectionHead {
font-weight: bold;
font-size: x-small;
}
.section {
padding: 4px;
}
#footer {
padding: 3px 10px 3px 10px;
font-size: x-small;
}
#breadcrumbs {
font-size: x-small;
margin: 0pt;
}
.source {
padding: 12px;
margin: 1em 7px 1em 7px;
}
.source pre {
margin: 0px;
padding: 0px;
}
#navcolumn img.imageLink, .imageLink {
padding-left: 0px;
padding-bottom: 0px;
padding-top: 0px;
padding-right: 2px;
border: 0px;
margin: 0px;
}
CodeNarc-0.23/docs/css/site.css 0000644 0001750 0001750 00000000067 12471222451 015645 0 ustar ebourg ebourg tt {
font-size: 110%;
font-weight: bolder;
} CodeNarc-0.23/README.txt 0000644 0001750 0001750 00000002101 12471223336 014137 0 ustar ebourg ebourg CodeNarc -- http://codenarc.org/
-------------------------------------------------------------------------------
CodeNarc is a static analysis tool for Groovy source code, enabling monitoring and enforcement of
many coding standards and best practices. CodeNarc applies a set of Rules (predefined and/or custom)
that are applied to each Groovy file, and generates an HTML or XML report of the results, including a
list of rules violated for each source file, and a count of the number of violations per package and
for the whole project.
CodeNarc is similar to popular static analysis tools such as PMD or Checkstyle. Unlike those tools
which analyze Java code, CodeNarc analyzes Groovy code.
DEPENDENCIES
CodeNarc requires
- Groovy version 1.7 or later
- The Log4J jar, version 1.2.13 or later, accessible on the CLASSPATH
(http://logging.apache.org/log4j/index.html).
AVAILABLE FROM MAVEN CENTRAL REPOSITORY
For projects built using Maven, CodeNarc is available from the Maven Central Repository.
- groupId = org.codenarc
- artifactId = CodeNarc
CodeNarc-0.23/src/ 0000755 0001750 0001750 00000000000 12303254654 013237 5 ustar ebourg ebourg CodeNarc-0.23/src/main/ 0000755 0001750 0001750 00000000000 12303254653 014162 5 ustar ebourg ebourg CodeNarc-0.23/src/main/resources/ 0000755 0001750 0001750 00000000000 12623571301 016171 5 ustar ebourg ebourg CodeNarc-0.23/src/main/resources/rulesets/ 0000755 0001750 0001750 00000000000 12623571301 020037 5 ustar ebourg ebourg CodeNarc-0.23/src/main/resources/rulesets/concurrency.xml 0000644 0001750 0001750 00000004664 12137611550 023126 0 ustar ebourg ebourg
Concurrency rule set.
These rules check for unsafe or unrecommended practices related to concurrency.
CodeNarc-0.23/src/main/resources/rulesets/groovyism.xml 0000644 0001750 0001750 00000005657 12130415314 022626 0 ustar ebourg ebourg
Groovy-ism rule set.
These are rules for Groovy idiomatic usage, and Groovy-specific bad practices
CodeNarc-0.23/src/main/resources/rulesets/grails.xml 0000644 0001750 0001750 00000002455 12275724374 022065 0 ustar ebourg ebourg
Grails rule set.
These rules implement standards and best practices related to the Grails framework (http://grails.org).
CodeNarc-0.23/src/main/resources/rulesets/naming.xml 0000644 0001750 0001750 00000002506 12407655411 022042 0 ustar ebourg ebourg
Naming rule set.
These rules validate names within the source code.
CodeNarc-0.23/src/main/resources/rulesets/formatting.xml 0000644 0001750 0001750 00000004760 12312164351 022740 0 ustar ebourg ebourg
Formatting rule set.
These rules find formatting problems within the source code.
CodeNarc-0.23/src/main/resources/rulesets/unnecessary.xml 0000644 0001750 0001750 00000010106 12414042210 023104 0 ustar ebourg ebourg
Unnecessary rule set.
These rules check for unnecessary code.
CodeNarc-0.23/src/main/resources/rulesets/size.xml 0000644 0001750 0001750 00000001770 12444433061 021541 0 ustar ebourg ebourg
Size and complexity rule set.
These rules check against thresholds for code size and complexity.
CodeNarc-0.23/src/main/resources/rulesets/serialization.xml 0000644 0001750 0001750 00000001415 12143045754 023444 0 ustar ebourg ebourg
Serialization rule set.
These rules check for Java serialization-specific violations.
CodeNarc-0.23/src/main/resources/rulesets/exceptions.xml 0000644 0001750 0001750 00000003740 12316051000 022732 0 ustar ebourg ebourg
Exceptions rule set.
These rules implement standards and best practices related to catching and throwing of exceptions.
CodeNarc-0.23/src/main/resources/rulesets/generic.xml 0000644 0001750 0001750 00000002037 12322630267 022202 0 ustar ebourg ebourg
Generic rule set.
These rules are generic, and are intended to be customized.
CodeNarc-0.23/src/main/resources/rulesets/enhanced.xml 0000644 0001750 0001750 00000001734 12167646706 022352 0 ustar ebourg ebourg
Enhanced classpath rule set.
These rules use a later compilation phase for parsing of the Groovy source code, allowing CodeNarc
to use a richer and more complete Abstract Syntax Tree (AST). The downside is that the later
compiler phase requires CodeNarc to have the application classes being analyzed, as well as
any referenced classes, on the classpath.
CodeNarc-0.23/src/main/resources/rulesets/jdbc.xml 0000644 0001750 0001750 00000001300 12006632012 021445 0 ustar ebourg ebourg
JDBC rule set.
These rules check for JDBC-specific violations.
CodeNarc-0.23/src/main/resources/rulesets/dry.xml 0000644 0001750 0001750 00000001335 12006632014 021353 0 ustar ebourg ebourg
Dry rule set.
These rules check for duplicate code, enforcing the DRY (Don't Repeat Yourself) principle.
CodeNarc-0.23/src/main/resources/rulesets/unused.xml 0000644 0001750 0001750 00000001617 12006632016 022065 0 ustar ebourg ebourg
Unused rule set.
These rules check for unused definitions within the source code.
CodeNarc-0.23/src/main/resources/rulesets/design.xml 0000644 0001750 0001750 00000003716 12440206243 022036 0 ustar ebourg ebourg
Design rule set.
These rules implement standards and best practices related to design issues.
CodeNarc-0.23/src/main/resources/rulesets/logging.xml 0000644 0001750 0001750 00000001776 12006632012 022212 0 ustar ebourg ebourg
Logging rule set.
These rules implement standards and best practices related to logging and output.
CodeNarc-0.23/src/main/resources/rulesets/basic.xml 0000644 0001750 0001750 00000006570 12323514421 021647 0 ustar ebourg ebourg
Basic rule set.
These rules are intended to be broadly (if not universally) applicable.
CodeNarc-0.23/src/main/resources/rulesets/security.xml 0000644 0001750 0001750 00000002062 12275775662 022453 0 ustar ebourg ebourg
Security rule set.
These rules find security problems within the source code.
CodeNarc-0.23/src/main/resources/rulesets/convention.xml 0000644 0001750 0001750 00000002231 12414302051 022731 0 ustar ebourg ebourg
Convention rule set.
These are rules for coding conventions; not necessarily errors.
CodeNarc-0.23/src/main/resources/rulesets/junit.xml 0000644 0001750 0001750 00000004261 12323241527 021716 0 ustar ebourg ebourg
JUnit rule set.
These rules implement standards and best practices related to JUnit tests.
CodeNarc-0.23/src/main/resources/rulesets/imports.xml 0000644 0001750 0001750 00000001703 12304644133 022257 0 ustar ebourg ebourg
Imports rule set.
These rules implement standards and best practices related to import statements.
CodeNarc-0.23/src/main/resources/rulesets/braces.xml 0000644 0001750 0001750 00000001337 12006632014 022016 0 ustar ebourg ebourg
Braces rule set.
These rules implement standards and best practices related to using braces.
CodeNarc-0.23/src/main/resources/codenarc-version.txt 0000644 0001750 0001750 00000000004 12466776322 022204 0 ustar ebourg ebourg 0.23 CodeNarc-0.23/src/main/resources/templates/ 0000755 0001750 0001750 00000000000 12623571301 020167 5 ustar ebourg ebourg CodeNarc-0.23/src/main/resources/templates/StarterRuleSet-AllRules.groovy.template 0000644 0001750 0001750 00000000635 12040564656 027735 0 ustar ebourg ebourg ruleset {
description '''
A Sample Groovy RuleSet containing all CodeNarc Rules
You can use this as a template for your own custom RuleSet.
Just delete the rules that you don't want to include.
'''
<% rules.each { rule -> def extraInfo = ruleExtraInformation[rule.name] ? " // ${ruleExtraInformation[rule.name]}" : '' %>${rule.name} ${extraInfo}
<% } %>
} CodeNarc-0.23/src/main/resources/templates/StarterRuleSet-AllRulesByCategory.groovy.template 0000644 0001750 0001750 00000000764 12040564672 031727 0 ustar ebourg ebourg ruleset {
description '''
A Sample Groovy RuleSet containing all CodeNarc Rules, grouped by category.
You can use this as a template for your own custom RuleSet.
Just delete the rules that you don't want to include.
'''
<% ruleSets.each { name, rules -> %>// ${name}
<% rules.each { rule -> def extraInfo = ruleExtraInformation[rule.name] ? " // ${ruleExtraInformation[rule.name]}" : '' %>${rule.name} ${extraInfo}
<% } %>
<% } %>
} CodeNarc-0.23/src/main/resources/templates/codenarc-rule-index.apt.template 0000644 0001750 0001750 00000001235 12414255261 026342 0 ustar ebourg ebourg --------------------------------------------------
CodeNarc - Rule Index
--------------------------------------------------
Rule Index
~~~~~~~~~~
<> includes ${numberOfRules} rules.
<% ruleSets.each { name, rules -> %>
<% def ruleSetLink = "codenarc-rules-${name}.html" %>
<% def capitalizedName = name.capitalize() %>
* {{{$ruleSetLink}$capitalizedName}}
<% rules.each { rule -> %>
<% def extraInfo = ruleExtraInformation[rule.name] ? " (${ruleExtraInformation[rule.name]})" : '' %>
* {{{./codenarc-rules-${name}.html#${rule.name}}${rule.name}}} ${extraInfo}
<% } %>
<% } %>
CodeNarc-0.23/src/main/resources/codenarc-base-rules.properties 0000644 0001750 0001750 00000065051 12470770455 024147 0 ustar ebourg ebourg # CodeNarc Rules (see PropertiesFileRuleRegistry): Tue Feb 17 20:55:57 EST 2015
AbcComplexity = org.codenarc.rule.size.AbcComplexityRule
AbcMetric = org.codenarc.rule.size.AbcMetricRule
AbstractClassName = org.codenarc.rule.naming.AbstractClassNameRule
AbstractClassWithPublicConstructor = org.codenarc.rule.design.AbstractClassWithPublicConstructorRule
AbstractClassWithoutAbstractMethod = org.codenarc.rule.design.AbstractClassWithoutAbstractMethodRule
AddEmptyString = org.codenarc.rule.unnecessary.AddEmptyStringRule
AssertWithinFinallyBlock = org.codenarc.rule.basic.AssertWithinFinallyBlockRule
AssignCollectionSort = org.codenarc.rule.groovyism.AssignCollectionSortRule
AssignCollectionUnique = org.codenarc.rule.groovyism.AssignCollectionUniqueRule
AssignmentInConditional = org.codenarc.rule.basic.AssignmentInConditionalRule
BigDecimalInstantiation = org.codenarc.rule.basic.BigDecimalInstantiationRule
BitwiseOperatorInConditional = org.codenarc.rule.basic.BitwiseOperatorInConditionalRule
BlankLineBeforePackage = org.codenarc.rule.formatting.BlankLineBeforePackageRule
BooleanGetBoolean = org.codenarc.rule.basic.BooleanGetBooleanRule
BooleanMethodReturnsNull = org.codenarc.rule.design.BooleanMethodReturnsNullRule
BracesForClass = org.codenarc.rule.formatting.BracesForClassRule
BracesForForLoop = org.codenarc.rule.formatting.BracesForForLoopRule
BracesForIfElse = org.codenarc.rule.formatting.BracesForIfElseRule
BracesForMethod = org.codenarc.rule.formatting.BracesForMethodRule
BracesForTryCatchFinally = org.codenarc.rule.formatting.BracesForTryCatchFinallyRule
BrokenNullCheck = org.codenarc.rule.basic.BrokenNullCheckRule
BrokenOddnessCheck = org.codenarc.rule.basic.BrokenOddnessCheckRule
BuilderMethodWithSideEffects = org.codenarc.rule.design.BuilderMethodWithSideEffectsRule
BusyWait = org.codenarc.rule.concurrency.BusyWaitRule
CatchArrayIndexOutOfBoundsException = org.codenarc.rule.exceptions.CatchArrayIndexOutOfBoundsExceptionRule
CatchError = org.codenarc.rule.exceptions.CatchErrorRule
CatchException = org.codenarc.rule.exceptions.CatchExceptionRule
CatchIllegalMonitorStateException = org.codenarc.rule.exceptions.CatchIllegalMonitorStateExceptionRule
CatchIndexOutOfBoundsException = org.codenarc.rule.exceptions.CatchIndexOutOfBoundsExceptionRule
CatchNullPointerException = org.codenarc.rule.exceptions.CatchNullPointerExceptionRule
CatchRuntimeException = org.codenarc.rule.exceptions.CatchRuntimeExceptionRule
CatchThrowable = org.codenarc.rule.exceptions.CatchThrowableRule
ChainedTest = org.codenarc.rule.junit.ChainedTestRule
ClassForName = org.codenarc.rule.basic.ClassForNameRule
ClassJavadoc = org.codenarc.rule.formatting.ClassJavadocRule
ClassName = org.codenarc.rule.naming.ClassNameRule
ClassNameSameAsFilename = org.codenarc.rule.naming.ClassNameSameAsFilenameRule
ClassSize = org.codenarc.rule.size.ClassSizeRule
CloneWithoutCloneable = org.codenarc.rule.design.CloneWithoutCloneableRule
CloneableWithoutClone = org.codenarc.rule.design.CloneableWithoutCloneRule
CloseWithoutCloseable = org.codenarc.rule.design.CloseWithoutCloseableRule
ClosureAsLastMethodParameter = org.codenarc.rule.groovyism.ClosureAsLastMethodParameterRule
ClosureStatementOnOpeningLineOfMultipleLineClosure = org.codenarc.rule.formatting.ClosureStatementOnOpeningLineOfMultipleLineClosureRule
CollectAllIsDeprecated = org.codenarc.rule.groovyism.CollectAllIsDeprecatedRule
CompareToWithoutComparable = org.codenarc.rule.design.CompareToWithoutComparableRule
ComparisonOfTwoConstants = org.codenarc.rule.basic.ComparisonOfTwoConstantsRule
ComparisonWithSelf = org.codenarc.rule.basic.ComparisonWithSelfRule
ConfusingClassNamedException = org.codenarc.rule.exceptions.ConfusingClassNamedExceptionRule
ConfusingMethodName = org.codenarc.rule.naming.ConfusingMethodNameRule
ConfusingMultipleReturns = org.codenarc.rule.groovyism.ConfusingMultipleReturnsRule
ConfusingTernary = org.codenarc.rule.convention.ConfusingTernaryRule
ConsecutiveBlankLines = org.codenarc.rule.formatting.ConsecutiveBlankLinesRule
ConsecutiveLiteralAppends = org.codenarc.rule.unnecessary.ConsecutiveLiteralAppendsRule
ConsecutiveStringConcatenation = org.codenarc.rule.unnecessary.ConsecutiveStringConcatenationRule
ConstantAssertExpression = org.codenarc.rule.basic.ConstantAssertExpressionRule
ConstantIfExpression = org.codenarc.rule.basic.ConstantIfExpressionRule
ConstantTernaryExpression = org.codenarc.rule.basic.ConstantTernaryExpressionRule
ConstantsOnlyInterface = org.codenarc.rule.design.ConstantsOnlyInterfaceRule
CouldBeElvis = org.codenarc.rule.convention.CouldBeElvisRule
CoupledTestCase = org.codenarc.rule.junit.CoupledTestCaseRule
CrapMetric = org.codenarc.rule.size.CrapMetricRule
CyclomaticComplexity = org.codenarc.rule.size.CyclomaticComplexityRule
DeadCode = org.codenarc.rule.basic.DeadCodeRule
DirectConnectionManagement = org.codenarc.rule.jdbc.DirectConnectionManagementRule
DoubleCheckedLocking = org.codenarc.rule.concurrency.DoubleCheckedLockingRule
DoubleNegative = org.codenarc.rule.basic.DoubleNegativeRule
DuplicateCaseStatement = org.codenarc.rule.basic.DuplicateCaseStatementRule
DuplicateImport = org.codenarc.rule.imports.DuplicateImportRule
DuplicateListLiteral = org.codenarc.rule.dry.DuplicateListLiteralRule
DuplicateMapKey = org.codenarc.rule.basic.DuplicateMapKeyRule
DuplicateMapLiteral = org.codenarc.rule.dry.DuplicateMapLiteralRule
DuplicateNumberLiteral = org.codenarc.rule.dry.DuplicateNumberLiteralRule
DuplicateSetValue = org.codenarc.rule.basic.DuplicateSetValueRule
DuplicateStringLiteral = org.codenarc.rule.dry.DuplicateStringLiteralRule
ElseBlockBraces = org.codenarc.rule.braces.ElseBlockBracesRule
EmptyCatchBlock = org.codenarc.rule.basic.EmptyCatchBlockRule
EmptyClass = org.codenarc.rule.basic.EmptyClassRule
EmptyElseBlock = org.codenarc.rule.basic.EmptyElseBlockRule
EmptyFinallyBlock = org.codenarc.rule.basic.EmptyFinallyBlockRule
EmptyForStatement = org.codenarc.rule.basic.EmptyForStatementRule
EmptyIfStatement = org.codenarc.rule.basic.EmptyIfStatementRule
EmptyInstanceInitializer = org.codenarc.rule.basic.EmptyInstanceInitializerRule
EmptyMethod = org.codenarc.rule.basic.EmptyMethodRule
EmptyMethodInAbstractClass = org.codenarc.rule.design.EmptyMethodInAbstractClassRule
EmptyStaticInitializer = org.codenarc.rule.basic.EmptyStaticInitializerRule
EmptySwitchStatement = org.codenarc.rule.basic.EmptySwitchStatementRule
EmptySynchronizedStatement = org.codenarc.rule.basic.EmptySynchronizedStatementRule
EmptyTryBlock = org.codenarc.rule.basic.EmptyTryBlockRule
EmptyWhileStatement = org.codenarc.rule.basic.EmptyWhileStatementRule
EnumCustomSerializationIgnored = org.codenarc.rule.serialization.EnumCustomSerializationIgnoredRule
EqualsAndHashCode = org.codenarc.rule.basic.EqualsAndHashCodeRule
EqualsOverloaded = org.codenarc.rule.basic.EqualsOverloadedRule
ExceptionExtendsError = org.codenarc.rule.exceptions.ExceptionExtendsErrorRule
ExceptionExtendsThrowable = org.codenarc.rule.exceptions.ExceptionExtendsThrowableRule
ExceptionNotThrown = org.codenarc.rule.exceptions.ExceptionNotThrownRule
ExplicitArrayListInstantiation = org.codenarc.rule.groovyism.ExplicitArrayListInstantiationRule
ExplicitCallToAndMethod = org.codenarc.rule.groovyism.ExplicitCallToAndMethodRule
ExplicitCallToCompareToMethod = org.codenarc.rule.groovyism.ExplicitCallToCompareToMethodRule
ExplicitCallToDivMethod = org.codenarc.rule.groovyism.ExplicitCallToDivMethodRule
ExplicitCallToEqualsMethod = org.codenarc.rule.groovyism.ExplicitCallToEqualsMethodRule
ExplicitCallToGetAtMethod = org.codenarc.rule.groovyism.ExplicitCallToGetAtMethodRule
ExplicitCallToLeftShiftMethod = org.codenarc.rule.groovyism.ExplicitCallToLeftShiftMethodRule
ExplicitCallToMinusMethod = org.codenarc.rule.groovyism.ExplicitCallToMinusMethodRule
ExplicitCallToModMethod = org.codenarc.rule.groovyism.ExplicitCallToModMethodRule
ExplicitCallToMultiplyMethod = org.codenarc.rule.groovyism.ExplicitCallToMultiplyMethodRule
ExplicitCallToOrMethod = org.codenarc.rule.groovyism.ExplicitCallToOrMethodRule
ExplicitCallToPlusMethod = org.codenarc.rule.groovyism.ExplicitCallToPlusMethodRule
ExplicitCallToPowerMethod = org.codenarc.rule.groovyism.ExplicitCallToPowerMethodRule
ExplicitCallToRightShiftMethod = org.codenarc.rule.groovyism.ExplicitCallToRightShiftMethodRule
ExplicitCallToXorMethod = org.codenarc.rule.groovyism.ExplicitCallToXorMethodRule
ExplicitGarbageCollection = org.codenarc.rule.basic.ExplicitGarbageCollectionRule
ExplicitHashMapInstantiation = org.codenarc.rule.groovyism.ExplicitHashMapInstantiationRule
ExplicitHashSetInstantiation = org.codenarc.rule.groovyism.ExplicitHashSetInstantiationRule
ExplicitLinkedHashMapInstantiation = org.codenarc.rule.groovyism.ExplicitLinkedHashMapInstantiationRule
ExplicitLinkedListInstantiation = org.codenarc.rule.groovyism.ExplicitLinkedListInstantiationRule
ExplicitStackInstantiation = org.codenarc.rule.groovyism.ExplicitStackInstantiationRule
ExplicitTreeSetInstantiation = org.codenarc.rule.groovyism.ExplicitTreeSetInstantiationRule
FactoryMethodName = org.codenarc.rule.naming.FactoryMethodNameRule
FieldName = org.codenarc.rule.naming.FieldNameRule
FileCreateTempFile = org.codenarc.rule.security.FileCreateTempFileRule
FileEndsWithoutNewline = org.codenarc.rule.formatting.FileEndsWithoutNewlineRule
FinalClassWithProtectedMember = org.codenarc.rule.design.FinalClassWithProtectedMemberRule
ForLoopShouldBeWhileLoop = org.codenarc.rule.basic.ForLoopShouldBeWhileLoopRule
ForStatementBraces = org.codenarc.rule.braces.ForStatementBracesRule
GStringAsMapKey = org.codenarc.rule.groovyism.GStringAsMapKeyRule
GStringExpressionWithinString = org.codenarc.rule.groovyism.GStringExpressionWithinStringRule
GetterMethodCouldBeProperty = org.codenarc.rule.groovyism.GetterMethodCouldBePropertyRule
GrailsDomainHasEquals = org.codenarc.rule.grails.GrailsDomainHasEqualsRule
GrailsDomainHasToString = org.codenarc.rule.grails.GrailsDomainHasToStringRule
GrailsDomainReservedSqlKeywordName = org.codenarc.rule.grails.GrailsDomainReservedSqlKeywordNameRule
GrailsDomainWithServiceReference = org.codenarc.rule.grails.GrailsDomainWithServiceReferenceRule
GrailsDuplicateConstraint = org.codenarc.rule.grails.GrailsDuplicateConstraintRule
GrailsDuplicateMapping = org.codenarc.rule.grails.GrailsDuplicateMappingRule
GrailsMassAssignment = org.codenarc.rule.grails.GrailsMassAssignmentRule
GrailsPublicControllerMethod = org.codenarc.rule.grails.GrailsPublicControllerMethodRule
GrailsServletContextReference = org.codenarc.rule.grails.GrailsServletContextReferenceRule
GrailsSessionReference = org.codenarc.rule.grails.GrailsSessionReferenceRule
GrailsStatelessService = org.codenarc.rule.grails.GrailsStatelessServiceRule
GroovyLangImmutable = org.codenarc.rule.groovyism.GroovyLangImmutableRule
HardCodedWindowsFileSeparator = org.codenarc.rule.basic.HardCodedWindowsFileSeparatorRule
HardCodedWindowsRootDirectory = org.codenarc.rule.basic.HardCodedWindowsRootDirectoryRule
HashtableIsObsolete = org.codenarc.rule.convention.HashtableIsObsoleteRule
IfStatementBraces = org.codenarc.rule.braces.IfStatementBracesRule
IfStatementCouldBeTernary = org.codenarc.rule.convention.IfStatementCouldBeTernaryRule
IllegalClassMember = org.codenarc.rule.generic.IllegalClassMemberRule
IllegalClassReference = org.codenarc.rule.generic.IllegalClassReferenceRule
IllegalPackageReference = org.codenarc.rule.generic.IllegalPackageReferenceRule
IllegalRegex = org.codenarc.rule.generic.IllegalRegexRule
IllegalString = org.codenarc.rule.generic.IllegalStringRule
IllegalSubclass = org.codenarc.rule.generic.IllegalSubclassRule
ImplementationAsType = org.codenarc.rule.design.ImplementationAsTypeRule
ImportFromSamePackage = org.codenarc.rule.imports.ImportFromSamePackageRule
ImportFromSunPackages = org.codenarc.rule.imports.ImportFromSunPackagesRule
InconsistentPropertyLocking = org.codenarc.rule.concurrency.InconsistentPropertyLockingRule
InconsistentPropertySynchronization = org.codenarc.rule.concurrency.InconsistentPropertySynchronizationRule
InsecureRandom = org.codenarc.rule.security.InsecureRandomRule
Instanceof = org.codenarc.rule.design.InstanceofRule
IntegerGetInteger = org.codenarc.rule.basic.IntegerGetIntegerRule
InterfaceName = org.codenarc.rule.naming.InterfaceNameRule
InvertedIfElse = org.codenarc.rule.convention.InvertedIfElseRule
JUnitAssertAlwaysFails = org.codenarc.rule.junit.JUnitAssertAlwaysFailsRule
JUnitAssertAlwaysSucceeds = org.codenarc.rule.junit.JUnitAssertAlwaysSucceedsRule
JUnitAssertEqualsConstantActualValue = org.codenarc.rule.junit.JUnitAssertEqualsConstantActualValueRule
JUnitFailWithoutMessage = org.codenarc.rule.junit.JUnitFailWithoutMessageRule
JUnitLostTest = org.codenarc.rule.junit.JUnitLostTestRule
JUnitPublicField = org.codenarc.rule.junit.JUnitPublicFieldRule
JUnitPublicNonTestMethod = org.codenarc.rule.junit.JUnitPublicNonTestMethodRule
JUnitPublicProperty = org.codenarc.rule.junit.JUnitPublicPropertyRule
JUnitSetUpCallsSuper = org.codenarc.rule.junit.JUnitSetUpCallsSuperRule
JUnitStyleAssertions = org.codenarc.rule.junit.JUnitStyleAssertionsRule
JUnitTearDownCallsSuper = org.codenarc.rule.junit.JUnitTearDownCallsSuperRule
JUnitTestMethodWithoutAssert = org.codenarc.rule.junit.JUnitTestMethodWithoutAssertRule
JUnitUnnecessarySetUp = org.codenarc.rule.junit.JUnitUnnecessarySetUpRule
JUnitUnnecessaryTearDown = org.codenarc.rule.junit.JUnitUnnecessaryTearDownRule
JUnitUnnecessaryThrowsException = org.codenarc.rule.junit.JUnitUnnecessaryThrowsExceptionRule
JavaIoPackageAccess = org.codenarc.rule.security.JavaIoPackageAccessRule
JdbcConnectionReference = org.codenarc.rule.jdbc.JdbcConnectionReferenceRule
JdbcResultSetReference = org.codenarc.rule.jdbc.JdbcResultSetReferenceRule
JdbcStatementReference = org.codenarc.rule.jdbc.JdbcStatementReferenceRule
LineLength = org.codenarc.rule.formatting.LineLengthRule
LocaleSetDefault = org.codenarc.rule.design.LocaleSetDefaultRule
LoggerForDifferentClass = org.codenarc.rule.logging.LoggerForDifferentClassRule
LoggerWithWrongModifiers = org.codenarc.rule.logging.LoggerWithWrongModifiersRule
LoggingSwallowsStacktrace = org.codenarc.rule.logging.LoggingSwallowsStacktraceRule
LongLiteralWithLowerCaseL = org.codenarc.rule.convention.LongLiteralWithLowerCaseLRule
MethodCount = org.codenarc.rule.size.MethodCountRule
MethodName = org.codenarc.rule.naming.MethodNameRule
MethodSize = org.codenarc.rule.size.MethodSizeRule
MisorderedStaticImports = org.codenarc.rule.imports.MisorderedStaticImportsRule
MissingBlankLineAfterImports = org.codenarc.rule.formatting.MissingBlankLineAfterImportsRule
MissingBlankLineAfterPackage = org.codenarc.rule.formatting.MissingBlankLineAfterPackageRule
MissingNewInThrowStatement = org.codenarc.rule.exceptions.MissingNewInThrowStatementRule
MultipleLoggers = org.codenarc.rule.logging.MultipleLoggersRule
MultipleUnaryOperators = org.codenarc.rule.basic.MultipleUnaryOperatorsRule
NestedBlockDepth = org.codenarc.rule.size.NestedBlockDepthRule
NestedForLoop = org.codenarc.rule.design.NestedForLoopRule
NestedSynchronization = org.codenarc.rule.concurrency.NestedSynchronizationRule
NoDef = org.codenarc.rule.convention.NoDefRule
NoWildcardImports = org.codenarc.rule.imports.NoWildcardImportsRule
NonFinalPublicField = org.codenarc.rule.security.NonFinalPublicFieldRule
NonFinalSubclassOfSensitiveInterface = org.codenarc.rule.security.NonFinalSubclassOfSensitiveInterfaceRule
ObjectFinalize = org.codenarc.rule.security.ObjectFinalizeRule
ObjectOverrideMisspelledMethodName = org.codenarc.rule.naming.ObjectOverrideMisspelledMethodNameRule
PackageName = org.codenarc.rule.naming.PackageNameRule
PackageNameMatchesFilePath = org.codenarc.rule.naming.PackageNameMatchesFilePathRule
ParameterCount = org.codenarc.rule.size.ParameterCountRule
ParameterName = org.codenarc.rule.naming.ParameterNameRule
ParameterReassignment = org.codenarc.rule.convention.ParameterReassignmentRule
PrintStackTrace = org.codenarc.rule.logging.PrintStackTraceRule
Println = org.codenarc.rule.logging.PrintlnRule
PrivateFieldCouldBeFinal = org.codenarc.rule.design.PrivateFieldCouldBeFinalRule
PropertyName = org.codenarc.rule.naming.PropertyNameRule
PublicFinalizeMethod = org.codenarc.rule.security.PublicFinalizeMethodRule
PublicInstanceField = org.codenarc.rule.design.PublicInstanceFieldRule
RandomDoubleCoercedToZero = org.codenarc.rule.basic.RandomDoubleCoercedToZeroRule
RemoveAllOnSelf = org.codenarc.rule.basic.RemoveAllOnSelfRule
RequiredRegex = org.codenarc.rule.generic.RequiredRegexRule
RequiredString = org.codenarc.rule.generic.RequiredStringRule
ReturnFromFinallyBlock = org.codenarc.rule.basic.ReturnFromFinallyBlockRule
ReturnNullFromCatchBlock = org.codenarc.rule.exceptions.ReturnNullFromCatchBlockRule
ReturnsNullInsteadOfEmptyArray = org.codenarc.rule.design.ReturnsNullInsteadOfEmptyArrayRule
ReturnsNullInsteadOfEmptyCollection = org.codenarc.rule.design.ReturnsNullInsteadOfEmptyCollectionRule
SerialPersistentFields = org.codenarc.rule.serialization.SerialPersistentFieldsRule
SerialVersionUID = org.codenarc.rule.serialization.SerialVersionUIDRule
SerializableClassMustDefineSerialVersionUID = org.codenarc.rule.serialization.SerializableClassMustDefineSerialVersionUIDRule
SimpleDateFormatMissingLocale = org.codenarc.rule.design.SimpleDateFormatMissingLocaleRule
SpaceAfterCatch = org.codenarc.rule.formatting.SpaceAfterCatchRule
SpaceAfterClosingBrace = org.codenarc.rule.formatting.SpaceAfterClosingBraceRule
SpaceAfterComma = org.codenarc.rule.formatting.SpaceAfterCommaRule
SpaceAfterFor = org.codenarc.rule.formatting.SpaceAfterForRule
SpaceAfterIf = org.codenarc.rule.formatting.SpaceAfterIfRule
SpaceAfterOpeningBrace = org.codenarc.rule.formatting.SpaceAfterOpeningBraceRule
SpaceAfterSemicolon = org.codenarc.rule.formatting.SpaceAfterSemicolonRule
SpaceAfterSwitch = org.codenarc.rule.formatting.SpaceAfterSwitchRule
SpaceAfterWhile = org.codenarc.rule.formatting.SpaceAfterWhileRule
SpaceAroundClosureArrow = org.codenarc.rule.formatting.SpaceAroundClosureArrowRule
SpaceAroundMapEntryColon = org.codenarc.rule.formatting.SpaceAroundMapEntryColonRule
SpaceAroundOperator = org.codenarc.rule.formatting.SpaceAroundOperatorRule
SpaceBeforeClosingBrace = org.codenarc.rule.formatting.SpaceBeforeClosingBraceRule
SpaceBeforeOpeningBrace = org.codenarc.rule.formatting.SpaceBeforeOpeningBraceRule
SpockIgnoreRestUsed = org.codenarc.rule.junit.SpockIgnoreRestUsedRule
StatelessClass = org.codenarc.rule.generic.StatelessClassRule
StatelessSingleton = org.codenarc.rule.design.StatelessSingletonRule
StaticCalendarField = org.codenarc.rule.concurrency.StaticCalendarFieldRule
StaticConnection = org.codenarc.rule.concurrency.StaticConnectionRule
StaticDateFormatField = org.codenarc.rule.concurrency.StaticDateFormatFieldRule
StaticMatcherField = org.codenarc.rule.concurrency.StaticMatcherFieldRule
StaticSimpleDateFormatField = org.codenarc.rule.concurrency.StaticSimpleDateFormatFieldRule
SwallowThreadDeath = org.codenarc.rule.exceptions.SwallowThreadDeathRule
SynchronizedMethod = org.codenarc.rule.concurrency.SynchronizedMethodRule
SynchronizedOnBoxedPrimitive = org.codenarc.rule.concurrency.SynchronizedOnBoxedPrimitiveRule
SynchronizedOnGetClass = org.codenarc.rule.concurrency.SynchronizedOnGetClassRule
SynchronizedOnReentrantLock = org.codenarc.rule.concurrency.SynchronizedOnReentrantLockRule
SynchronizedOnString = org.codenarc.rule.concurrency.SynchronizedOnStringRule
SynchronizedOnThis = org.codenarc.rule.concurrency.SynchronizedOnThisRule
SynchronizedReadObjectMethod = org.codenarc.rule.concurrency.SynchronizedReadObjectMethodRule
SystemErrPrint = org.codenarc.rule.logging.SystemErrPrintRule
SystemExit = org.codenarc.rule.security.SystemExitRule
SystemOutPrint = org.codenarc.rule.logging.SystemOutPrintRule
SystemRunFinalizersOnExit = org.codenarc.rule.concurrency.SystemRunFinalizersOnExitRule
TernaryCouldBeElvis = org.codenarc.rule.convention.TernaryCouldBeElvisRule
ThisReferenceEscapesConstructor = org.codenarc.rule.concurrency.ThisReferenceEscapesConstructorRule
ThreadGroup = org.codenarc.rule.concurrency.ThreadGroupRule
ThreadLocalNotStaticFinal = org.codenarc.rule.concurrency.ThreadLocalNotStaticFinalRule
ThreadYield = org.codenarc.rule.concurrency.ThreadYieldRule
ThrowError = org.codenarc.rule.exceptions.ThrowErrorRule
ThrowException = org.codenarc.rule.exceptions.ThrowExceptionRule
ThrowExceptionFromFinallyBlock = org.codenarc.rule.basic.ThrowExceptionFromFinallyBlockRule
ThrowNullPointerException = org.codenarc.rule.exceptions.ThrowNullPointerExceptionRule
ThrowRuntimeException = org.codenarc.rule.exceptions.ThrowRuntimeExceptionRule
ThrowThrowable = org.codenarc.rule.exceptions.ThrowThrowableRule
ToStringReturnsNull = org.codenarc.rule.design.ToStringReturnsNullRule
TrailingWhitespace = org.codenarc.rule.formatting.TrailingWhitespaceRule
UnnecessaryBigDecimalInstantiation = org.codenarc.rule.unnecessary.UnnecessaryBigDecimalInstantiationRule
UnnecessaryBigIntegerInstantiation = org.codenarc.rule.unnecessary.UnnecessaryBigIntegerInstantiationRule
UnnecessaryBooleanExpression = org.codenarc.rule.unnecessary.UnnecessaryBooleanExpressionRule
UnnecessaryBooleanInstantiation = org.codenarc.rule.unnecessary.UnnecessaryBooleanInstantiationRule
UnnecessaryCallForLastElement = org.codenarc.rule.unnecessary.UnnecessaryCallForLastElementRule
UnnecessaryCallToSubstring = org.codenarc.rule.unnecessary.UnnecessaryCallToSubstringRule
UnnecessaryCast = org.codenarc.rule.unnecessary.UnnecessaryCastRule
UnnecessaryCatchBlock = org.codenarc.rule.unnecessary.UnnecessaryCatchBlockRule
UnnecessaryCollectCall = org.codenarc.rule.unnecessary.UnnecessaryCollectCallRule
UnnecessaryCollectionCall = org.codenarc.rule.unnecessary.UnnecessaryCollectionCallRule
UnnecessaryConstructor = org.codenarc.rule.unnecessary.UnnecessaryConstructorRule
UnnecessaryDefInFieldDeclaration = org.codenarc.rule.unnecessary.UnnecessaryDefInFieldDeclarationRule
UnnecessaryDefInMethodDeclaration = org.codenarc.rule.unnecessary.UnnecessaryDefInMethodDeclarationRule
UnnecessaryDefInVariableDeclaration = org.codenarc.rule.unnecessary.UnnecessaryDefInVariableDeclarationRule
UnnecessaryDotClass = org.codenarc.rule.unnecessary.UnnecessaryDotClassRule
UnnecessaryDoubleInstantiation = org.codenarc.rule.unnecessary.UnnecessaryDoubleInstantiationRule
UnnecessaryElseStatement = org.codenarc.rule.unnecessary.UnnecessaryElseStatementRule
UnnecessaryFail = org.codenarc.rule.junit.UnnecessaryFailRule
UnnecessaryFinalOnPrivateMethod = org.codenarc.rule.unnecessary.UnnecessaryFinalOnPrivateMethodRule
UnnecessaryFloatInstantiation = org.codenarc.rule.unnecessary.UnnecessaryFloatInstantiationRule
UnnecessaryGString = org.codenarc.rule.unnecessary.UnnecessaryGStringRule
UnnecessaryGetter = org.codenarc.rule.unnecessary.UnnecessaryGetterRule
UnnecessaryGroovyImport = org.codenarc.rule.imports.UnnecessaryGroovyImportRule
UnnecessaryIfStatement = org.codenarc.rule.unnecessary.UnnecessaryIfStatementRule
UnnecessaryInstanceOfCheck = org.codenarc.rule.unnecessary.UnnecessaryInstanceOfCheckRule
UnnecessaryInstantiationToGetClass = org.codenarc.rule.unnecessary.UnnecessaryInstantiationToGetClassRule
UnnecessaryIntegerInstantiation = org.codenarc.rule.unnecessary.UnnecessaryIntegerInstantiationRule
UnnecessaryLongInstantiation = org.codenarc.rule.unnecessary.UnnecessaryLongInstantiationRule
UnnecessaryModOne = org.codenarc.rule.unnecessary.UnnecessaryModOneRule
UnnecessaryNullCheck = org.codenarc.rule.unnecessary.UnnecessaryNullCheckRule
UnnecessaryNullCheckBeforeInstanceOf = org.codenarc.rule.unnecessary.UnnecessaryNullCheckBeforeInstanceOfRule
UnnecessaryObjectReferences = org.codenarc.rule.unnecessary.UnnecessaryObjectReferencesRule
UnnecessaryOverridingMethod = org.codenarc.rule.unnecessary.UnnecessaryOverridingMethodRule
UnnecessaryPackageReference = org.codenarc.rule.unnecessary.UnnecessaryPackageReferenceRule
UnnecessaryParenthesesForMethodCallWithClosure = org.codenarc.rule.unnecessary.UnnecessaryParenthesesForMethodCallWithClosureRule
UnnecessaryPublicModifier = org.codenarc.rule.unnecessary.UnnecessaryPublicModifierRule
UnnecessaryReturnKeyword = org.codenarc.rule.unnecessary.UnnecessaryReturnKeywordRule
UnnecessarySafeNavigationOperator = org.codenarc.rule.unnecessary.UnnecessarySafeNavigationOperatorRule
UnnecessarySelfAssignment = org.codenarc.rule.unnecessary.UnnecessarySelfAssignmentRule
UnnecessarySemicolon = org.codenarc.rule.unnecessary.UnnecessarySemicolonRule
UnnecessaryStringInstantiation = org.codenarc.rule.unnecessary.UnnecessaryStringInstantiationRule
UnnecessarySubstring = org.codenarc.rule.unnecessary.UnnecessarySubstringRule
UnnecessaryTernaryExpression = org.codenarc.rule.unnecessary.UnnecessaryTernaryExpressionRule
UnnecessaryToString = org.codenarc.rule.unnecessary.UnnecessaryToStringRule
UnnecessaryTransientModifier = org.codenarc.rule.unnecessary.UnnecessaryTransientModifierRule
UnsafeArrayDeclaration = org.codenarc.rule.security.UnsafeArrayDeclarationRule
UnsafeImplementationAsMap = org.codenarc.rule.security.UnsafeImplementationAsMapRule
UnusedArray = org.codenarc.rule.unused.UnusedArrayRule
UnusedImport = org.codenarc.rule.imports.UnusedImportRule
UnusedMethodParameter = org.codenarc.rule.unused.UnusedMethodParameterRule
UnusedObject = org.codenarc.rule.unused.UnusedObjectRule
UnusedPrivateField = org.codenarc.rule.unused.UnusedPrivateFieldRule
UnusedPrivateMethod = org.codenarc.rule.unused.UnusedPrivateMethodRule
UnusedPrivateMethodParameter = org.codenarc.rule.unused.UnusedPrivateMethodParameterRule
UnusedVariable = org.codenarc.rule.unused.UnusedVariableRule
UseAssertEqualsInsteadOfAssertTrue = org.codenarc.rule.junit.UseAssertEqualsInsteadOfAssertTrueRule
UseAssertFalseInsteadOfNegation = org.codenarc.rule.junit.UseAssertFalseInsteadOfNegationRule
UseAssertNullInsteadOfAssertEquals = org.codenarc.rule.junit.UseAssertNullInsteadOfAssertEqualsRule
UseAssertSameInsteadOfAssertTrue = org.codenarc.rule.junit.UseAssertSameInsteadOfAssertTrueRule
UseAssertTrueInsteadOfAssertEquals = org.codenarc.rule.junit.UseAssertTrueInsteadOfAssertEqualsRule
UseAssertTrueInsteadOfNegation = org.codenarc.rule.junit.UseAssertTrueInsteadOfNegationRule
UseCollectMany = org.codenarc.rule.groovyism.UseCollectManyRule
UseCollectNested = org.codenarc.rule.groovyism.UseCollectNestedRule
UseOfNotifyMethod = org.codenarc.rule.concurrency.UseOfNotifyMethodRule
VariableName = org.codenarc.rule.naming.VariableNameRule
VectorIsObsolete = org.codenarc.rule.convention.VectorIsObsoleteRule
VolatileArrayField = org.codenarc.rule.concurrency.VolatileArrayFieldRule
VolatileLongOrDoubleField = org.codenarc.rule.concurrency.VolatileLongOrDoubleFieldRule
WaitOutsideOfWhileLoop = org.codenarc.rule.concurrency.WaitOutsideOfWhileLoopRule
WhileStatementBraces = org.codenarc.rule.braces.WhileStatementBracesRule
CodeNarc-0.23/src/main/resources/codenarc-htmlreport.css 0000644 0001750 0001750 00000004365 12006632012 022657 0 ustar ebourg ebourg body {
font-family: Arial, sans-serif;
margin: 20px 20px 20px 30px;
}
h1, h2, h3 {
font-weight: bold;
}
h1 {
width: 400px;
text-align: center;
color: white;
background-color: #557799;
padding: 10px;
-moz-box-shadow: 3px 3px 4px #AAA;
-webkit-box-shadow: 3px 3px 4px #AAA;
box-shadow: 3px 3px 4px #AAA;
border-radius: 10px;
-moz-border-radius: 10px;
text-shadow: 2px 2px 2px black;
}
h2 {
font-size: 150%;
margin-top: 40px;
padding-top: 5px;
border-top: 5px solid lightgray;
}
h3 {
margin-left: 10px;
margin-top: 30px;
}
a {
text-decoration: underline;
color: #D93544;
}
.logo {
float: right;
}
.metadata {
}
.summary {
margin-bottom: 20px;
}
.reportInfo {
font-size: 110%;
}
.allPackages {
font-weight: bold;
}
.fileHeader {
font-size: 120%;
font-weight: bold;
}
.tableHeader {
font-weight: bold;
}
.number {
text-align: center;
}
.priority1, .priority2, .priority3 {
font-weight: bold;
text-align: center;
color: #990000;
}
.priority1 {
background-color: #FFAAAA;
}
.priority2 {
background-color: #FFCCAA;
}
.priority3 {
background-color: #FFEEAA;
}
.ruleName {
font-weight: bold;
color: black;
text-align: left;
}
.violationInfo {
margin-bottom: 2px;
margin-top: 2px;
}
.violationInfoPrefix {
font-size: 60%;
width: 30px;
color: #a9a9a9;
padding-right: 4px;
}
.sourceCode {
font-family: Arial, sans-serif;
font-size: 80%;
color: #444444;
}
.violationMessage {
font-style: italic;
font-size: 80%;
color: black;
}
.ruleDescriptions {
font-size: 85%;
}
.version {
margin-top: 1px;
}
table {
border: 2px solid gray;
border-collapse: collapse;
-moz-box-shadow: 3px 3px 4px #AAA;
-webkit-box-shadow: 3px 3px 4px #AAA;
box-shadow: 3px 3px 4px #AAA;
}
td, th {
border: 1px solid #D3D3D3;
padding: 4px 20px 4px 20px;
}
th {
text-shadow: 2px 2px 2px white;
}
th {
border-bottom: 1px solid gray;
background-color: #DDDDFF;
}
em, .em {
font-weight: bold;
} CodeNarc-0.23/src/main/resources/ruleset-schema.xsd 0000644 0001750 0001750 00000005656 12006632014 021640 0 ustar ebourg ebourg
CodeNarc-0.23/src/main/resources/codenarc-rule-extrainfo.properties 0000644 0001750 0001750 00000000573 12055542262 025037 0 ustar ebourg ebourg # Optional extra information display next to rule names in the rule index and sample rule sets
AbcComplexity = DEPRECATED: Use the AbcMetric rule instead. Requires the GMetrics jar
AbcMetric = Requires the GMetrics jar
CrapMetric = Requires the GMetrics jar and a Cobertura coverage file
CyclomaticComplexity = Requires the GMetrics jar
GrailsSessionReference = DEPRECATED
CodeNarc-0.23/src/main/resources/codenarc-base-messages.properties 0000644 0001750 0001750 00000450217 12450011363 024606 0 ustar ebourg ebourg UnnecessarySafeNavigationOperator.description=Check for the safe navigation operator (?.) applied to constants and literals, which can never be null.
UnnecessarySafeNavigationOperator.description.html=Check for the safe navigation operator (?.) applied to constants and literals, which can never be null.
Instanceof.description=Checks for use of the instanceof operator. Use the ignoreTypeNames property to configure ignored type names.
Instanceof.description.html=Checks for use of the instanceof operator. Use the ignoreTypeNames property to configure ignored type names.
MultipleUnaryOperators.description=Checks for multiple consecutive unary operators. These are confusing, and are likely typos and bugs.
MultipleUnaryOperators.description.html=Checks for multiple consecutive unary operators. These are confusing, and are likely typos and bugs.
ToStringReturnsNull.description=Checks for toString() methods that return null.
ToStringReturnsNull.description.html=Checks for toString() methods that return null.
JUnitPublicProperty.description=Checks for public properties defined on JUnit test classes. There should be no need to expose a public property on a test class.
JUnitPublicProperty.description.html=Checks for public properties defined on JUnit test classes. There should be no need to expose a public property on a test class.
UnnecessaryToString.description=Checks for unnecessary calls to toString().
UnnecessaryToString.description.html=Checks for unnecessary calls to toString().
IllegalSubclass.description=Checks for classes that extend one of the specified set of illegal superclasses configured in superclassNames.
IllegalSubclass.description.html=Checks for classes that extend one of the specified set of illegal superclasses configured in superclassNames.
UnnecessaryCast.description=Checks for unnecessary cast operations
UnnecessaryCast.description.html=Checks for unnecessary cast operations
ExceptionExtendsThrowable.description=Checks for classes that extend Throwable. Custom exception classes should subclass Exception or one of its descendants.
ExceptionExtendsThrowable.description.html=Checks for classes that extend java.lang.Throwable. Custom exception classes should subclass java.lang.Exception or one of its descendants.
ClosureStatementOnOpeningLineOfMultipleLineClosure.description=Checks for closure logic on first line (after ->) for a multi-line closure.
ClosureStatementOnOpeningLineOfMultipleLineClosure.description.html=Checks for closure logic on first line (after ->) for a multi-line closure.
SpaceAroundMapEntryColon.description=Check for configured formatting of whitespace around colons for literal Map entries. The characterBeforeColonRegex and characterAfterColonRegex properties specify a regular expression that must match the character before/after the colon.
SpaceAroundMapEntryColon.description.html=Check for configured formatting of whitespace around colons for literal Map entries. The characterBeforeColonRegex and characterAfterColonRegex properties specify a regular expression that must match the character before/after the colon.
IllegalString.description=Checks for a specified illegal string within the source code.
IllegalString.description.html=Checks for a specified illegal string within the source code.
LocaleSetDefault.description=Checks for calls to Locale.setDefault(), which sets the Locale across the entire JVM.
LocaleSetDefault.description.html=Checks for calls to Locale.setDefault(), which sets the Locale across the entire JVM.
SpaceAroundClosureArrow.description=Checks that there is whitespace around the closure arrow (->) symbol
SpaceAroundClosureArrow.description.html=Checks that there is whitespace around the closure arrow (->) symbol
EnumCustomSerializationIgnored.description=Checks for enums that define writeObject() or writeReplace() methods, or declare serialPersistentFields or serialVersionUID fields, all of which are ignored for enums.
EnumCustomSerializationIgnored.description.html=Checks for enums that define writeObject() or writeReplace() methods, or declare serialPersistentFields or serialVersionUID fields, all of which are ignored for enums.
IllegalClassMember.description=Checks for classes containing fields/properties/methods matching configured illegal member modifiers or not matching any of the configured allowed member modifiers.
IllegalClassMember.description.html=Checks for classes containing fields/properties/methods matching configured illegal member modifiers or not matching any of the configured allowed member modifiers.
GStringExpressionWithinString.description=Check for regular (single quote) strings containing a GString-type expression (\\${...}).
GStringExpressionWithinString.description.html=Check for regular (single quote) strings containing a GString-type expression (\\${...}).
JUnitPublicField.description=Checks for public field on a JUnit test class
JUnitPublicField.description.html=Checks for public field on a JUnit test class
FactoryMethodName.description=A factory method is a method that creates objects, and they are typically named either buildFoo(), makeFoo(), or createFoo(). This rule enforces that only one naming convention is used. It defaults to makeFoo(), but that can be changed using the property 'regex'.
FactoryMethodName.description.html=A factory method is a method that creates objects, and they are typically named either buildFoo(), makeFoo(), or createFoo(). This rule enforces that only one naming convention is used. It defaults to makeFoo(), but that can be changed using the property 'regex'.
BuilderMethodWithSideEffects.description=A builder method is defined as one that creates objects. As such, they should never be of void return type. If a method is named build, create, or make, then it should always return a value.
BuilderMethodWithSideEffects.description.html=A builder method is defined as one that creates objects. As such, they should never be of void return type. If a method is named build, create, or make, then it should always return a value.
UnusedMethodParameter.description=This rule finds instances of method parameters not being used. It does not analyze private methods (that is done by the UnusedPrivateMethodParameter rule) or methods marked @Override.
UnusedMethodParameter.description.html=This rule finds instances of method parameters not being used. It does not analyze private methods (that is done by the UnusedPrivateMethodParameter rule) or methods marked @Override.
UnnecessaryDefInFieldDeclaration.description=If a field has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance, 'static def constraints = {}' is redundant and can be simplified to 'static constraints = {}.
UnnecessaryDefInFieldDeclaration.description.html=If a field has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance, 'static def constraints = {}' is redundant and can be simplified to 'static constraints = {}.
GetterMethodCouldBeProperty.description=If a class defines a public method that follows the Java getter notation, and returns a constant, then it is cleaner to provide a Groovy property for the value rather than a Groovy method.
GetterMethodCouldBeProperty.description.html=If a class defines a public method that follows the Java getter notation, and returns a constant, then it is cleaner to provide a Groovy property for the value rather than a Groovy method.
ConfusingMultipleReturns.description=Multiple return values can be used to set several variables at once. To use multiple return values, the left hand side of the assignment must be enclosed in parenthesis. If not, then you are not using multiple return values, you're only assigning the last element.
ConfusingMultipleReturns.description.html=Multiple return values can be used to set several variables at once. To use multiple return values, the left hand side of the assignment must be enclosed in parenthesis. If not, then you are not using multiple return values, you're only assigning the last element.
LongLiteralWithLowerCaseL.description=In Java and Groovy, you can specify long literals with the L or l character, for instance 55L or 24l. It is best practice to always use an uppercase L and never a lowercase l. This is because 11l rendered in some fonts may look like 111 instead of 11L.
LongLiteralWithLowerCaseL.description.html=In Java and Groovy, you can specify long literals with the L or l character, for instance 55L or 24l. It is best practice to always use an uppercase L and never a lowercase l. This is because 11l rendered in some fonts may look like 111 instead of 11L.
CouldBeElvis.description=Catch an if block that could be written as an elvis expression.
CouldBeElvis.description.html=Catch an if block that could be written as an elvis expression.
ClassJavadoc.description=Makes sure each class and interface definition is preceded by javadoc. Enum definitions are not checked, due to strange behavior in the Groovy AST.
ClassJavadoc.description.html=Makes sure each class and interface definition is preceded by javadoc. Enum definitions are not checked, due to strange behavior in the Groovy AST.
BlankLineBeforePackage.description=Makes sure there are no blank lines before the package declaration of a source code file.
BlankLineBeforePackage.description.html=Makes sure there are no blank lines before the package declaration of a source code file.
BracesForTryCatchFinally.description=Checks the location of the opening brace ({) for try statements. By default, requires them on the line, but the sameLine property can be set to false to override this.
BracesForTryCatchFinally.description.html=Checks the location of the opening brace ({) for try statements. By default, requires them on the line, but the sameLine property can be set to false to override this.
BracesForMethod.description=Checks the location of the opening brace ({) for constructors and methods. By default, requires them on the same line, but the sameLine property can be set to false to override this.
BracesForMethod.description.html=Checks the location of the opening brace ({) for constructors and methods. By default, requires them on the same line, but the sameLine property can be set to false to override this.
BracesForIfElse.description=Checks the location of the opening brace ({) for if statements. By default, requires them on the same line, but the sameLine property can be set to false to override this.
BracesForIfElse.description.html=Checks the location of the opening brace ({) for if statements. By default, requires them on the same line, but the sameLine property can be set to false to override this.
BracesForForLoop.description=Checks the location of the opening brace ({) for for loops. By default, requires them on the same line, but the sameLine property can be set to false to override this.
BracesForForLoop.description.html=Checks the location of the opening brace ({) for for loops. By default, requires them on the same line, but the sameLine property can be set to false to override this.
FileEndsWithoutNewline.description=Makes sure the source code file ends with a newline character.
FileEndsWithoutNewline.description.html=Makes sure the source code file ends with a newline character.
LineLength.description=Checks the maximum length for each line of source code. It checks for number of characters, so lines that include tabs may appear longer than the allowed number when viewing the file. The maximum line length can be configured by setting the length property, which defaults to 120.
LineLength.description.html=Checks the maximum length for each line of source code. It checks for number of characters, so lines that include tabs may appear longer than the allowed number when viewing the file. The maximum line length can be configured by setting the length property, which defaults to 120.
MissingBlankLineAfterPackage.description=Makes sure there is a blank line after the package statement of a source code file.
MissingBlankLineAfterPackage.description.html=Makes sure there is a blank line after the package statement of a source code file.
ConsecutiveBlankLines.description=Makes sure there are no consecutive lines that are either blank or whitespace only.
ConsecutiveBlankLines.description.html=Makes sure there are no consecutive lines that are either blank or whitespace only.
MissingBlankLineAfterImports.description=Makes sure there is a blank line after the imports of a source code file.
MissingBlankLineAfterImports.description.html=Makes sure there is a blank line after the imports of a source code file.
GrailsDomainHasToString.description=Checks that Grails domain classes redefine toString()
GrailsDomainHasToString.description.html=Checks that Grails domain classes redefine toString()
GrailsDomainHasEquals.description=Checks that Grails domain classes redefine equals().
GrailsDomainHasEquals.description.html=Checks that Grails domain classes redefine equals().
GrailsDomainWithServiceReference.description=Checks that Grails domain classes do not have service classes injected.
GrailsDomainWithServiceReference.description.html=Checks that Grails domain classes do not have service classes injected.
GrailsDomainReservedSqlKeywordName.description=Forbids usage of SQL reserved keywords as class or field names in Grails domain classes. Naming a domain class (or its field) with such a keyword causes SQL schema creation errors and/or redundant table/column name mappings.
GrailsDomainReservedSqlKeywordName.description.html=Forbids usage of SQL reserved keywords as class or field names in Grails domain classes. Naming a domain class (or its field) with such a keyword causes SQL schema creation errors and/or redundant table/column name mappings.
BracesForClass.description=Checks the location of the opening brace ({) for classes. By default, requires them on the same line, but the sameLine property can be set to false to override this.
BracesForClass.description.html=Checks the location of the opening brace ({) for classes. By default, requires them on the same line, but the sameLine property can be set to false to override this.
RandomDoubleCoercedToZero.description=The Math.random() method returns a double result greater than or equal to 0.0 and less than 1.0. If you coerce this result into an Integer or int, then it is coerced to zero. Casting the result to int, or assigning it to an int field is probably a bug.
RandomDoubleCoercedToZero.description.html=The Math.random() method returns a double result greater than or equal to 0.0 and less than 1.0. If you coerce this result into an Integer or int, then it is coerced to zero. Casting the result to int, or assigning it to an int field is probably a bug.
HardCodedWindowsFileSeparator.description=This rule finds usages of a Windows file separator within the constructor call of a File object. It is better to use the Unix file separator or use the File.separator constant.
HardCodedWindowsFileSeparator.description.html=This rule finds usages of a Windows file separator within the constructor call of a File object. It is better to use the Unix file separator or use the File.separator constant.
HardCodedWindowsRootDirectory.description=This rule find cases where a File object is constructed with a windows-based path. This is not portable, and using the File.listRoots() method is a better alternative.
HardCodedWindowsRootDirectory.description.html=This rule find cases where a File object is constructed with a windows-based path. This is not portable, and using the File.listRoots() method is a better alternative.
UnnecessarySubstring.description=This rule finds usages of String.substring(int) and String.substring(int, int) that can be replaced by use of the subscript operator. For instance, var.substring(5) can be replaced with var[5..-1].
UnnecessarySubstring.description.html=This rule finds usages of String.substring(int) and String.substring(int, int) that can be replaced by use of the subscript operator. For instance, var.substring(5) can be replaced with var[5..-1].
UnnecessaryInstanceOfCheck.description=This rule finds instanceof checks that cannot possibly evaluate to true. For instance, checking that (!variable instanceof String) will never be true because the result of a not expression is always a boolean.
UnnecessaryInstanceOfCheck.description.html=This rule finds instanceof checks that cannot possibly evaluate to true. For instance, checking that (!variable instanceof String) will never be true because the result of a not expression is always a boolean.
BitwiseOperatorInConditional.description=Checks for bitwise operations in conditionals, if you need to do a bitwise operation then it is best practive to extract a temp variable.
BitwiseOperatorInConditional.description.html=Checks for bitwise operations in conditionals, if you need to do a bitwise operation then it is best practive to extract a temp variable.
AssignCollectionSort.description=The Collections.sort() method mutates the list and returns the list as a value. If you are assigning the result of sort() to a variable, then you probably don't realize that you're also modifying the original list as well. This is frequently the cause of subtle bugs.
AssignCollectionSort.description.html=The Collections.sort() method mutates the list and returns the list as a value. If you are assigning the result of sort() to a variable, then you probably don't realize that you're also modifying the original list as well. This is frequently the cause of subtle bugs.
AssignCollectionUnique.description=The Collections.unique() method mutates the list and returns the list as a value. If you are assigning the result of unique() to a variable, then you probably don't realize that you're also modifying the original list as well. This is frequently the cause of subtle bugs.
AssignCollectionUnique.description.html=The Collections.unique() method mutates the list and returns the list as a value. If you are assigning the result of unique() to a variable, then you probably don't realize that you're also modifying the original list as well. This is frequently the cause of subtle bugs.
UnnecessaryDotClass.description=To make a reference to a class, it is unnecessary to specify the '.class' identifier. For instance String.class can be shortened to String.
UnnecessaryDotClass.description.html=To make a reference to a class, it is unnecessary to specify the '.class' identifier. For instance String.class can be shortened to String.
ClassForName.description=Using Class.forName(...) is a common way to add dynamic behavior to a system. However, using this method can cause resource leaks because the classes can be pinned in memory for long periods of time.
ClassForName.description.html=Using Class.forName(...) is a common way to add dynamic behavior to a system. However, using this method can cause resource leaks because the classes can be pinned in memory for long periods of time.
IllegalClassReference.description=Checks for reference to any of the classes configured in classNames.
IllegalClassReference.description.html=Checks for reference to any of the classes configured in classNames.
IllegalPackageReference.description=Checks for reference to any of the packages configured in packageNames.
IllegalPackageReference.description.html=Checks for reference to any of the packages configured in packageNames.
StaticSimpleDateFormatField.description=SimpleDateFormat objects should not be used as static fields. SimpleDateFormat are inherently unsafe for multi-threaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
StaticSimpleDateFormatField.description.html=SimpleDateFormat objects should not be used as static fields. SimpleDateFormat are inherently unsafe for multi-threaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
AbstractClassWithPublicConstructor.description=Checks for abstract classes that define a public constructor, which is useless and confusing.
AbstractClassWithPublicConstructor.description.html=Checks for abstract classes that define a public constructor, which is useless and confusing.
UnnecessaryPackageReference.description=Checks for explicit package reference for classes that Groovy imports by default, such as java.lang.String, java.util.Map and groovy.lang.Closure.
UnnecessaryPackageReference.description.html=Checks for explicit package reference for classes that Groovy imports by default, such as java.lang.String, java.util.Map and groovy.lang.Closure.
StaticConnection.description=Creates violations when a java.sql.Connection object is used as a static field. Database connections stored in static fields will be shared between threads, which is unsafe and can lead to race conditions.
StaticConnection.description.html=Creates violations when a java.sql.Connection object is used as a static field. Database connections stored in static fields will be shared between threads, which is unsafe and can lead to race conditions.
SerialPersistentFields.description=To use a Serializable object's serialPersistentFields correctly, it must be declared private, static, and final.
SerialPersistentFields.description.html=To use a Serializable object's serialPersistentFields correctly, it must be declared private, static, and final.
NonFinalPublicField.description=Finds code that violates secure coding principles for mobile code by declaring a member variable public but not final.
NonFinalPublicField.description.html=Finds code that violates secure coding principles for mobile code by declaring a member variable public but not final.
UnsafeImplementationAsMap.description=Reports incomplete interface implementations created by map-to-interface coercions. Example: [hasNext: { ... }] as Iterator (Not all Iterator methods are implemented. An UnsupportedOperationException will be thrown upon call to e.g. next().) By default, this rule does not apply to test files.
UnsafeImplementationAsMap.description.html=Reports incomplete interface implementations created by map-to-interface coercions. Example: [hasNext: { ... }] as Iterator (Not all Iterator methods are implemented. An UnsupportedOperationException will be thrown upon call to e.g. next().) By default, this rule does not apply to test files.
PublicInstanceField.description=Using public fields is considered to be a bad design. Use properties instead.
PublicInstanceField.description.html=Using public fields is considered to be a bad design. Use properties instead.
PublicFinalizeMethod.description=Creates a violation when the program violates secure coding principles by declaring a finalize() method public.
PublicFinalizeMethod.description.html=Creates a violation when the program violates secure coding principles by declaring a finalize() method public.
UnsafeArrayDeclaration.description=Triggers a violation when an array is declared public, final, and static. Secure coding principles state that, in most cases, an array declared public, final and static is a bug because arrays are mutable objects.
UnsafeArrayDeclaration.description.html=Triggers a violation when an array is declared public, final, and static. Secure coding principles state that, in most cases, an array declared public, final and static is a bug because arrays are mutable objects.
JavaIoPackageAccess.description=This rule reports violations of the Enterprise JavaBeans specification by using the java.io package to access files or the file system.
JavaIoPackageAccess.description.html=This rule reports violations of the Enterprise JavaBeans specification by using the java.io package to access files or the file system.
ObjectFinalize.description=The finalize() method should only be called by the JVM after the object has been garbage collected.
ObjectFinalize.description.html=The finalize() method should only be called by the JVM after the object has been garbage collected.
SystemExit.description=Web applications should never call System.exit(). A call to System.exit() is probably part of leftover debug code or code imported from a non-J2EE application.
SystemExit.description.html=Web applications should never call System.exit(). A call to System.exit() is probably part of leftover debug code or code imported from a non-J2EE application.
FileCreateTempFile.description=The File.createTempFile() method is insecure, and has been deprecated by the ESAPI secure coding library. It has been replaced by the ESAPI Randomizer.getRandomFilename(String) method.
FileCreateTempFile.description.html=The File.createTempFile() method is insecure, and has been deprecated by the ESAPI secure coding library. It has been replaced by the ESAPI Randomizer.getRandomFilename(String) method.
ComparisonOfTwoConstants.description=Checks for expressions where a comparison operator or equals() or compareTo() is used to compare two constants to each other or two literals that contain only constant values, e.g.: 23 == 67, Boolean.FALSE != false, 0.17 <= 0.99, "abc" > "ddd", [a:1] <=> [a:2], [1,2].equals([3,4]) or [a:false, b:true].compareTo(['a':34.5, b:Boolean.TRUE], where x is a variable.
ComparisonOfTwoConstants.description.html=Checks for expressions where a comparison operator or equals() or compareTo() is used to compare two constants to each other or two literals that contain only constant values., e.g.: 23 == 67, Boolean.FALSE != false, 0.17 <= 0.99, "abc" > "ddd", [a:1] <=> [a:2], [1,2].equals([3,4]) or [a:false, b:true].compareTo(['a':34.5, b:Boolean.TRUE].
ComparisonWithSelf.description=Checks for expressions where a comparison operator or equals() or compareTo() is used to compare a variable to itself, e.g.: x == x, x != x, x <=> x, x < x, x >= x, x.equals(x) or x.compareTo(x), where x is a variable.
ComparisonWithSelf.description.html=Checks for expressions where a comparison operator or equals() or compareTo() is used to compare a variable to itself, e.g.: x == x, x != x, x <=> x, x < x, x =>= x, x.equals(x) or x.compareTo(x), where x is a variable.
DirectConnectionManagement.description=The J2EE standard requires that applications use the container's resource management facilities to obtain connections to resources. Every major web application container provides pooled database connection management as part of its resource management framework. Duplicating this functionality in an application is difficult and error prone, which is part of the reason it is forbidden under the J2EE standard.
DirectConnectionManagement.description.html=The J2EE standard requires that applications use the container's resource management facilities to obtain connections to resources. Every major web application container provides pooled database connection management as part of its resource management framework. Duplicating this functionality in an application is difficult and error prone, which is part of the reason it is forbidden under the J2EE standard.
JdbcConnectionReference.description=Check for direct use of java.sql.Connection, which is discouraged and almost never necessary in application code.
JdbcConnectionReference.description.html=Check for direct use of java.sql.Connection, which is discouraged and almost never necessary in application code.
JdbcResultSetReference.description=Check for direct use of java.sql.ResultSet, which is not necessary if using the Groovy Sql facility or an ORM framework such as Hibernate.
JdbcResultSetReference.description.html=Check for direct use of java.sql.ResultSet, which is not necessary if using the Groovy Sql facility or an ORM framework such as Hibernate.
JdbcStatementReference.description=Check for direct use of java.sql.Statement, java.sql.PreparedStatement, or java.sql.CallableStatement, which is not necessary if using the Groovy Sql facility or an ORM framework such as Hibernate.
JdbcStatementReference.description.html=Check for direct use of java.sql.Statement, java.sql.PreparedStatement, or java.sql.CallableStatement, which is not necessary if using the Groovy Sql facility or an ORM framework such as Hibernate.
InsecureRandom.description=Reports usages of java.util.Random, which can produce very predictable results. If two instances of Random are created with the same seed and sequence of method calls, they will generate the exact same results. Use java.security.SecureRandom instead, which provides a cryptographically strong random number generator. SecureRandom uses PRNG, which means they are using a deterministic algorithm to produce a pseudo-random number from a true random seed. SecureRandom produces non-deterministic output.
InsecureRandom.description.html=Reports usages of java.util.Random, which can produce very predictable results. If two instances of Random are created with the same seed and sequence of method calls, they will generate the exact same results. Use java.security.SecureRandom instead, which provides a cryptographically strong random number generator. SecureRandom uses PRNG, which means they are using a deterministic algorithm to produce a pseudo-random number from a true random seed. SecureRandom produces non-deterministic output.
UnnecessaryFinalOnPrivateMethod.description=A private method is marked final. Private methods cannot be overridden, so marking it final is unnecessary.
UnnecessaryFinalOnPrivateMethod.description.html=A private method is marked final. Private methods cannot be overridden, so marking it final is unnecessary.
ImportFromSunPackages.description=Avoid importing anything from the 'sun.*' packages. These packages are not portable and are likely to change.
ImportFromSunPackages.description.html=Avoid importing anything from the 'sun.*' packages. These packages are not portable and are likely to change.
DuplicateSetValue.description=A Set literal is created with duplicate constant value. A set cannot contain two elements with the same value.
DuplicateSetValue.description.html=A Set literal is created with duplicate constant value. A set cannot contain two elements with the same value.
NonFinalSubclassOfSensitiveInterface.description=The permissions classes such as java.security.Permission and java.security.BasicPermission are designed to be extended. Classes that derive from these permissions classes, however, must prohibit extension. This prohibition ensures that malicious subclasses cannot change the properties of the derived class. Classes that implement sensitive interfaces such as java.security.PrivilegedAction and java.security.PrivilegedActionException must also be declared final for analogous reasons.
NonFinalSubclassOfSensitiveInterface.description.html=The permissions classes such as java.security.Permission and java.security.BasicPermission are designed to be extended. Classes that derive from these permissions classes, however, must prohibit extension. This prohibition ensures that malicious subclasses cannot change the properties of the derived class. Classes that implement sensitive interfaces such as java.security.PrivilegedAction and java.security.PrivilegedActionException must also be declared final for analogous reasons.
DuplicateMapKey.description=A map literal is created with duplicated key. The map entry will be overwritten.
DuplicateMapKey.description.html=A map literal is created with duplicated key. The map entry will be overwritten.
EqualsOverloaded.description=The class has an equals method, but the parameter of the method is not of type Object. It is not overriding equals but instead overloading it.
EqualsOverloaded.description.html=The class has an equals method, but the parameter of the method is not of type Object. It is not overriding equals but instead overloading it.
UnnecessaryGString.description=String objects should be created with single quotes, and GString objects created with double quotes. Creating normal String objects with double quotes is confusing to readers.
UnnecessaryGString.description.html=String objects should be created with single quotes, and GString objects created with double quotes. Creating normal String objects with double quotes is confusing to readers.
UnnecessarySemicolon.description=Semicolons as line terminators are not required in Groovy: remove them. Do not use a semicolon as a replacement for empty braces on for and while loops; this is a confusing practice.
UnnecessarySemicolon.description.html=Semicolons as line terminators are not required in Groovy: remove them. Do not use a semicolon as a replacement for empty braces on for and while loops; this is a confusing practice.
UnnecessaryDefInMethodDeclaration.description=If a method has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private method() {}' is redundant and can be simplified to 'private method() {}'.
UnnecessaryDefInMethodDeclaration.description.html=If a method has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private method() {}' is redundant and can be simplified to 'private method() {}'.
UnnecessaryDefInVariableDeclaration.description=If a variable has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private n = 2' is redundant and can be simplified to 'private n = 2'.
UnnecessaryDefInVariableDeclaration.description.html=If a variable has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance 'def private n = 2' is redundant and can be simplified to 'private n = 2'.
UnnecessaryPublicModifier.description=The 'public' modifier is not required on methods or classes.
UnnecessaryPublicModifier.description.html=The 'public' modifier is not required on methods or classes.
SpockIgnoreRestUsed.description=If Spock's @IgnoreRest appears on any method, all non-annotated test methods are not executed. This behaviour is almost always unintended. It's fine to use @IgnoreRest locally during development, but when committing code, it should be removed.
SpockIgnoreRestUsed.description.html=If Spock's @IgnoreRest appears on any method, all non-annotated test methods are not executed. This behaviour is almost always unintended. It's fine to use @IgnoreRest locally during development, but when committing code, it should be removed.
CoupledTestCase.description=This rule finds test cases that are coupled to other test cases, either by invoking static methods on another test case or by creating instances of another test case. If you require shared logic in test cases then extract that logic to a new class where it can properly be reused.
CoupledTestCase.description.html=This rule finds test cases that are coupled to other test cases, either by invoking static methods on another test case or by creating instances of another test case. If you require shared logic in test cases then extract that logic to a new class where it can properly be reused.
ChainedTest.description=A test method that invokes another test method is a chained test; the methods are dependent on one another. Tests should be isolated, and not be dependent on one another.
ChainedTest.description.html=A test method that invokes another test method is a chained test; the methods are dependent on one another. Tests should be isolated, and not be dependent on one another.
IntegerGetInteger.description=This rule catches usages of java.lang.Integer.getInteger(String, ...) which reads an Integer from the System properties. It is often mistakenly used to attempt to read user input or parse a String into an Integer. It is a poor piece of API to use; replace it with System.properties['prop'].
IntegerGetInteger.description.html=This rule catches usages of java.lang.Integer.getInteger(String, ...) which reads an Integer from the System properties. It is often mistakenly used to attempt to read user input or parse a String into an Integer. It is a poor piece of API to use; replace it with System.properties['prop'].
BooleanGetBoolean.description=This rule catches usages of java.lang.Boolean.getBoolean(String) which reads a boolean from the System properties. It is often mistakenly used to attempt to read user input or parse a String into a boolean. It is a poor piece of API to use; replace it with System.properties['prop'].
BooleanGetBoolean.description.html=This rule catches usages of java.lang.Boolean.getBoolean(String) which reads a boolean from the System properties. It is often mistakenly used to attempt to read user input or parse a String into a boolean. It is a poor piece of API to use; replace it with System.properties['prop'].
GroovyLangImmutable.description=The groovy.lang.Immutable annotation has been deprecated and replaced by groovy.transform.Immutable. Do not use the Immutable in groovy.lang.
GroovyLangImmutable.description.html=The groovy.lang.Immutable annotation has been deprecated and replaced by groovy.transform.Immutable. Do not use the Immutable in groovy.lang.
UnnecessaryFail.description=In a unit test, catching an exception and immediately calling Assert.fail() is pointless and hides the stack trace. It is better to rethrow the exception or not catch the exception at all.
UnnecessaryFail.description.html=In a unit test, catching an exception and immediately calling Assert.fail() is pointless and hides the stack trace. It is better to rethrow the exception or not catch the exception at all.
DoubleCheckedLocking.description=This rule detects double checked locking, where a 'lock hint' is tested for null before initializing an object within a synchronized block. Double checked locking does not guarantee correctness and is an anti-pattern.
DoubleCheckedLocking.description.html=This rule detects double checked locking, where a 'lock hint' is tested for null before initializing an object within a synchronized block. Double checked locking does not guarantee correctness and is an anti-pattern.
BusyWait.description=Busy waiting (forcing a Thread.sleep() while waiting on a condition) should be avoided. Prefer using the gate and barrier objects in the java.util.concurrent package.
BusyWait.description.html=Busy waiting (forcing a Thread.sleep() while waiting on a condition) should be avoided. Prefer using the gate and barrier objects in the java.util.concurrent package.
AssignmentInConditional.description=An assignment operator (=) was used in a conditional test. This is usually a typo, and the comparison operator (==) was intended.
AssignmentInConditional.description.html=An assignment operator (=) was used in a conditional test. This is usually a typo, and the comparison operator (==) was intended.
SynchronizedOnReentrantLock.description=Synchronizing on a ReentrantLock field is almost never the intended usage. A ReentrantLock should be obtained using the lock() method and released in a finally block using the unlock() method.
SynchronizedOnReentrantLock.description.html=Synchronizing on a ReentrantLock field is almost never the intended usage. A ReentrantLock should be obtained using the lock() method and released in a finally block using the unlock() method.
StaticMatcherField.description=Matcher objects should not be used as static fields. Matcher instances are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
StaticMatcherField.description.html=Matcher objects should not be used as static fields. Matcher instances are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
VolatileArrayField.description=Volatile array fields are unsafe because the contents of the array are not treated as volatile. Changing the entire array reference is visible to other threads, but changing an array element is not.
VolatileArrayField.description.html=Volatile array fields are unsafe because the contents of the array are not treated as volatile. Changing the entire array reference is visible to other threads, but changing an array element is not.
SynchronizedOnBoxedPrimitive.description=The code synchronizes on a boxed primitive constant, such as an Integer. Since Integer objects can be cached and shared, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness and possible deadlock
SynchronizedOnBoxedPrimitive.description.html=The code synchronizes on a boxed primitive constant, such as an Integer. Since Integer objects can be cached and shared, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness and possible deadlock
InconsistentPropertyLocking.description=Class contains similarly-named get and set methods where one method of the pair is marked either @WithReadLock or @WithWriteLock and the other is not locked at all.
InconsistentPropertyLocking.description.html=Class contains similarly-named get and set methods where one method of the pair is marked either @WithReadLock or @WithWriteLock and the other is not locked at all.
InconsistentPropertySynchronization.description=Class contains similarly-named get and set methods where the set method is synchronized and the get method is not, or the get method is synchronized and the set method is not.
InconsistentPropertySynchronization.description.html=Class contains similarly-named get and set methods where the set method is synchronized and the get method is not, or the get method is synchronized and the set method is not.
UnnecessaryTransientModifier.description=The field is marked as transient, but the class isn't Serializable, so marking it as transient has no effect.
UnnecessaryTransientModifier.description.html=The field is marked as transient, but the class isn't Serializable, so marking it as transient has no effect.
UnnecessarySelfAssignment.description=Method contains a pointless self-assignment to a variable or property.
UnnecessarySelfAssignment.description.html=Method contains a pointless self-assignment to a variable or property.
SynchronizedReadObjectMethod.description=Catches Serializable classes that define a synchronized readObject method. By definition, an object created by deserialization is only reachable by one thread, and thus there is no need for readObject() to be synchronized. If the readObject() method itself is causing the object to become visible to another thread, that is an example of very dubious coding style.
SynchronizedReadObjectMethod.description.html=Catches Serializable classes that define a synchronized readObject method. By definition, an object created by deserialization is only reachable by one thread, and thus there is no need for readObject() to be synchronized. If the readObject() method itself is causing the object to become visible to another thread, that is an example of very dubious coding style.
SynchronizedOnString.description=Synchronization on a String field can lead to deadlock because Strings are interned by the JVM and can be shared.
SynchronizedOnString.description.html=Synchronization on a String field can lead to deadlock because Strings are interned by the JVM and can be shared.
UnnecessaryCallToSubstring.description=Calling String.substring(0) always returns the original string. This code is meaningless.
UnnecessaryCallToSubstring.description.html=Calling String.substring(0) always returns the original string. This code is meaningless.
BrokenOddnessCheck.description=The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check for oddness, consider using x & 1 == 1, or x % 2 != 0.
BrokenOddnessCheck.description.html=The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check for oddness, consider using x & 1 == 1, or x % 2 != 0.
StaticDateFormatField.description=DateFormat objects should not be used as static fields. DateFormat are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
StaticDateFormatField.description.html=DateFormat objects should not be used as static fields. DateFormat are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
StaticCalendarField.description=Calendar objects should not be used as static fields. Calendars are inherently unsafe for multihtreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
StaticCalendarField.description.html=Calendar objects should not be used as static fields. Calendars are inherently unsafe for multihtreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
UnnecessaryModOne.description=Any expression mod 1 (exp % 1) is guaranteed to always return zero. This code is probably an error, and should be either (exp & 1) or (exp % 2).
UnnecessaryModOne.description.html=Any expression mod 1 (exp % 1) is guaranteed to always return zero. This code is probably an error, and should be either (exp & 1) or (exp % 2).
AddEmptyString.description=Finds empty string literals which are being added. This is an inefficient way to convert any type to a String.
AddEmptyString.description.html=Finds empty string literals which are being added. This is an inefficient way to convert any type to a String.
ConsecutiveStringConcatenation.description=Catches concatenation of two string literals on the same line. These can safely by joined.
ConsecutiveStringConcatenation.description.html=Catches concatenation of two string literals on the same line. These can safely by joined.
ConsecutiveLiteralAppends.description=Violations occur when method calls to append(Object) are chained together with literals as parameters. The chained calls can be joined into one invocation.
ConsecutiveLiteralAppends.description.html=Violations occur when method calls to append(Object) are chained together with literals as parameters. The chained calls can be joined into one invocation.
EmptyMethod.description=A method was found without an implementation. If the method is overriding or implementing a parent method, then mark it with the @Override annotation.
EmptyMethod.description.html=A method was found without an implementation. If the method is overriding or implementing a parent method, then mark it with the @Override annotation.
EmptyStaticInitializer.description=An empty static initializer was found. It is safe to remove it.
EmptyStaticInitializer.description.html=An empty static initializer was found. It is safe to remove it.
EmptyInstanceInitializer.description=An empty class instance initializer was found. It is safe to remove it.
EmptyInstanceInitializer.description.html=An empty class instance initializer was found. It is safe to remove it.
SerializableClassMustDefineSerialVersionUID.description=Classes that implement Serializable should define a serialVersionUID. If you don't define serialVersionUID, the system will make one by hashing most of your class's features. Then if you change anything, the UID will change and Java won't let you reload old data.
SerializableClassMustDefineSerialVersionUID.description.html=Classes that implement Serializable should define a serialVersionUID. If you don't define serialVersionUID, the system will make one by hashing most of your class's features. Then if you change anything, the UID will change and Java won't let you reload old data.
ThisReferenceEscapesConstructor.description=Reports constructors passing the 'this' reference to other methods. This equals exposing a half-baked objects and can lead to race conditions during initialization. For reference, see 'Java Concurrency Gotchas' by Alex Miller (http://www.slideshare.net/alexmiller/java-concurrency-gotchas-3666977/38) and 'Java theory and practice: Safe construction techniques' by Brian Goetz (http://www.ibm.com/developerworks/java/library/j-jtp0618/index.html).
ThisReferenceEscapesConstructor.description.html=Reports constructors passing the 'this' reference to other methods. This equals exposing a half-baked objects and can lead to race conditions during initialization. For reference, see Java Concurrency Gotchas by Alex Miller and Java theory and practice: Safe construction techniques by Brian Goetz.
ThreadGroup.description=Avoid using ThreadGroup; although it is intended to be used in a threaded environment it contains methods that are not thread safe.
ThreadGroup.description.html=Avoid using ThreadGroup; although it is intended to be used in a threaded environment it contains methods that are not thread safe.
BigDecimalInstantiation.description=Checks for calls to the BigDecimal constructors that take a double parameter, which may result in an unexpected BigDecimal value.
BigDecimalInstantiation.description.html=Checks for calls to the BigDecimal constructors that take a double parameter, which may result in an unexpected BigDecimal value.
BooleanMethodReturnsNull.description=Method with Boolean return type returns explicit null. A method that returns either Boolean.TRUE, Boolean.FALSE or null is an accident waiting to happen. This method can be invoked as though it returned a value of type boolean, and the compiler will insert automatic unboxing of the Boolean value. If a null value is returned, this will result in a NullPointerException.
BooleanMethodReturnsNull.description.html=Method with Boolean return type returns explicit null. A method that returns either Boolean.TRUE, Boolean.FALSE or null is an accident waiting to happen. This method can be invoked as though it returned a value of type boolean, and the compiler will insert automatic unboxing of the Boolean value. If a null value is returned, this will result in a NullPointerException.
CloneableWithoutClone.description=A class that implements java.lang.Cloneable should define a clone() method.
CloneableWithoutClone.description.html=A class that implements java.lang.Cloneable should define a clone() method.
CloneWithoutCloneable.description=The method clone() should only be declared if the class implements the Cloneable interface.
CloneWithoutCloneable.description.html=The method clone() should only be declared if the class implements the Cloneable interface.
CollectAllIsDeprecated.description=collectAll{} is deprecated since Groovy 1.8.1. Use collectNested instead{}.
CollectAllIsDeprecated.description.html=collectAll{} is deprecated since Groovy 1.8.1. Use collectNested instead{}.
CompareToWithoutComparable.description=If you implement a compareTo method then you should also implement the Comparable interface. If you don't then you could possibly get an exception if the Groovy == operator is invoked on your object. This is an issue fixed in Groovy 1.8 but present in previous versions.
CompareToWithoutComparable.description.html=If you implement a compareTo method then you should also implement the Comparable interface. If you don't then you could possibly get an exception if the Groovy == operator is invoked on your object. This is an issue fixed in Groovy 1.8 but present in previous versions.
ConfusingTernary.description=In a ternary expression avoid negation in the test. For example, rephrase: "(x != y) ? diff : same" as: "(x == y) ? same : diff". Consistent use of this rule makes the code easier to read. Also, this resolves trivial ordering problems, such as "does the error case go first?" or "does the common case go first?".
ConfusingTernary.description.html=In a ternary expression avoid negation in the test. For example, rephrase: "(x != y) ? diff : same" as: "(x == y) ? same : diff". Consistent use of this rule makes the code easier to read. Also, this resolves trivial ordering problems, such as "does the error case go first?" or "does the common case go first?".
ConstantIfExpression.description=Checks for if statements with a constant value for the if expression, such as true, false, null, or a literal constant value.
ConstantIfExpression.description.html=Checks for if statements with a constant value for the if expression, such as true, false, null, or a literal constant value.
ConstantTernaryExpression.description=Checks for ternary expressions with a constant value for the boolean expression, such as true, false, null, or a literal constant value.
ConstantTernaryExpression.description.html=Checks for ternary expressions with a constant value for the boolean expression, such as true, false, null, or a literal constant value.
DeadCode.description=Dead code appears after a return statement or an exception is thrown. If code appears after one of these statements then it will never be executed and can be safely deleted.
DeadCode.description.html=Dead code appears after a return statement or an exception is thrown. If code appears after one of these statements then it will never be executed and can be safely deleted.
DoubleNegative.description=There is no point in using a double negative, it is always positive. For instance !!x can always be simplified to x. And !(!x) can as well.
DoubleNegative.description.html=There is no point in using a double negative, it is always positive. For instance !!x can always be simplified to x. And !(!x) can as well.
NestedForLoop.description=Reports classes with nested for loops.
NestedForLoop.description.html=Reports classes with nested for loops.
DuplicateCaseStatement.description=Check for duplicate case statements in a switch block, such as two equal integers or strings.
DuplicateCaseStatement.description.html=Check for duplicate case statements in a switch block, such as two equal integers or strings.
EmptyCatchBlock.description=In most cases, exceptions should not be caught and ignored (swallowed).
EmptyCatchBlock.description.html=In most cases, exceptions should not be caught and ignored (swallowed).
EmptyClass.description=Reports classes without methods, fields or properties. Why would you need a class like this?
EmptyClass.description.html=Reports classes without methods, fields or properties. Why would you need a class like this?
EmptyTryBlock.description=Empty try blocks are confusing and serve no purpose.
EmptyTryBlock.description.html=Empty try blocks are confusing and serve no purpose.
EmptyFinallyBlock.description=Empty finally blocks are confusing and serve no purpose.
EmptyFinallyBlock.description.html=Empty finally blocks are confusing and serve no purpose.
EmptyIfStatement.description=Empty if statements are confusing and serve no purpose.
EmptyIfStatement.description.html=Empty if statements are confusing and serve no purpose.
EmptyElseBlock.description=Empty else blocks are confusing and serve no purpose.
EmptyElseBlock.description.html=Empty else blocks are confusing and serve no purpose.
EmptyForStatement.description=Empty for statements are confusing and serve no purpose.
EmptyForStatement.description.html=Empty for statements are confusing and serve no purpose.
EmptySwitchStatement.description=Empty switch statements are confusing and serve no purpose.
EmptySwitchStatement.description.html=Empty switch statements are confusing and serve no purpose.
EmptyWhileStatement.description=Empty while statements are confusing and serve no purpose.
EmptyWhileStatement.description.html=Empty while statements are confusing and serve no purpose.
EmptySynchronizedStatement.description=Empty synchronized statements are confusing and serve no purpose.
EmptySynchronizedStatement.description.html=Empty synchronized statements are confusing and serve no purpose.
EqualsAndHashCode.description=If either the equals(Object) or the hashCode() methods are overridden within a class, then both must be overridden.
EqualsAndHashCode.description.html=If either the boolean equals(Object) or the int hashCode() methods are overridden within a class, then both must be overridden.
ExplicitArrayListInstantiation.description=This rule checks for the explicit instantiation of a ArrayList using the no-arg constructor. In Groovy, it is best to write "new ArrayList()" as "[]", which creates the same object.
ExplicitArrayListInstantiation.description.html=This rule checks for the explicit instantiation of an ArrayList using the no-arg constructor. In Groovy, it is best to write new ArrayList() as [], which creates the same object.
ExplicitCallToModMethod.description=This rule detects when the mod(Object) method is called directly in code instead of using the % operator. A groovier way to express this: a.mod(b) is this: a % b
ExplicitCallToModMethod.description.html=This rule detects when the mod(Object) method is called directly in code instead of using the % operator. A groovier way to express this: a.mod(b) is this: a % b
ExplicitCallToPowerMethod.description=This rule detects when the power(Object) method is called directly in code instead of using the ** operator. A groovier way to express this: a.power(b) is this: a ** b
ExplicitCallToPowerMethod.description.html=This rule detects when the power(Object) method is called directly in code instead of using the ** operator. A groovier way to express this: a.power(b) is this: a ** b
ExplicitCallToDivMethod.description=This rule detects when the div(Object) method is called directly in code instead of using the / operator. A groovier way to express this: a.div(b) is this: a / b
ExplicitCallToDivMethod.description.html=This rule detects when the div(Object) method is called directly in code instead of using the / operator. A groovier way to express this: a.div(b) is this: a / b
ExplicitCallToMultiplyMethod.description=This rule detects when the minus(Object) method is called directly in code instead of using the * operator. A groovier way to express this: a.multiply(b) is this: a * b
ExplicitCallToMultiplyMethod.description.html=This rule detects when the minus(Object) method is called directly in code instead of using the * operator. A groovier way to express this: a.multiply(b) is this: a * b
ExplicitCallToMinusMethod.description=This rule detects when the minus(Object) method is called directly in code instead of using the - operator. A groovier way to express this: a.minus(b) is this: a - b
ExplicitCallToMinusMethod.description.html=This rule detects when the minus(Object) method is called directly in code instead of using the - operator. A groovier way to express this: a.minus(b) is this: a - b
ExplicitCallToRightShiftMethod.description=This rule detects when the rightShift(Object) method is called directly in code instead of using the >> operator. A groovier way to express this: a.rightShift(b) is this: a >> b
ExplicitCallToRightShiftMethod.description.html=This rule detects when the rightShift(Object) method is called directly in code instead of using the >> operator. A groovier way to express this: a.rightShift(b) is this: a >> b
ExplicitCallToLeftShiftMethod.description=This rule detects when the leftShift(Object) method is called directly in code instead of using the << operator. A groovier way to express this: a.leftShift(b) is this: a << b
ExplicitCallToLeftShiftMethod.description.html=This rule detects when the leftShift(Object) method is called directly in code instead of using the << operator. A groovier way to express this: a.leftShift(b) is this: a << b
ExplicitCallToGetAtMethod.description=This rule detects when the getAt(Object) method is called directly in code instead of using the [] index operator. A groovier way to express this: a.getAt(b) is this: a[b]
ExplicitCallToGetAtMethod.description.html=This rule detects when the getAt(Object) method is called directly in code instead of using the [] index operator. A groovier way to express this: a.getAt(b) is this: a[b]
ExplicitCallToXorMethod.description=This rule detects when the xor(Object) method is called directly in code instead of using the ^ operator. A groovier way to express this: a.xor(b) is this: a ^ b
ExplicitCallToXorMethod.description.html=This rule detects when the xor(Object) method is called directly in code instead of using the ^ operator. A groovier way to express this: a.xor(b) is this: a ^ b
ExplicitCallToAndMethod.description=This rule detects when the and(Object) method is called directly in code instead of using the & operator. A groovier way to express this: a.and(b) is this: a & b
ExplicitCallToAndMethod.description.html=This rule detects when the and(Object) method is called directly in code instead of using the & operator. A groovier way to express this: a.and(b) is this: a & b
ExplicitCallToOrMethod.description=This rule detects when the or(Object) method is called directly in code instead of using the | operator. A groovier way to express this: a.or(b) is this: a | b
ExplicitCallToOrMethod.description.html=This rule detects when the or(Object) method is called directly in code instead of using the | operator. A groovier way to express this: a.or(b) is this: a | b
ExplicitCallToPlusMethod.description=This rule detects when the plus(Object) method is called directly in code instead of using the + operator. A groovier way to express this: a.plus(b) is this: a + b
ExplicitCallToPlusMethod.description.html=This rule detects when the plus(Object) method is called directly in code instead of using the + operator. A groovier way to express this: a.plus(b) is this: a + b
ExplicitCallToEqualsMethod.description=This rule detects when the equals(Object) method is called directly in code instead of using the == or != operator. A groovier way to express this: a.equals(b) is this: a == b and a groovier way to express : !a.equals(b) is : a != b
ExplicitCallToEqualsMethod.description.html=This rule detects when the equals(Object) method is called directly in code instead of using the == or != operator. A groovier way to express this: a.equals(b) is this: a == b and a groovier way to express : !a.equals(b) is : a != b
ExplicitCallToCompareToMethod.description=This rule detects when the compareTo(Object) method is called directly in code instead of using the <=>, >, >=, <, and <= operators. A groovier way to express this: a.compareTo(b) is this: a <=> b, or using the other operators.
ExplicitCallToCompareToMethod.description.html=This rule detects when the compareTo(Object) method is called directly in code instead of using the <=>, >, >=, <, and <= operators. A groovier way to express this: a.compareTo(b) is this: a <=> b, or using the other operators.
ExplicitGarbageCollection.description=Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised. Code should have the same behavior whether the garbage collection is disabled using the option -Xdisableexplicitgc or not. Moreover, "modern" jvms do a very good job handling garbage collections. If memory usage issues unrelated to memory leaks develop within an application, it should be dealt with JVM options rather than within the code itself.
ExplicitGarbageCollection.description.html=Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised. Code should have the same behavior whether the garbage collection is disabled using the option -Xdisableexplicitgc or not. Moreover, "modern" jvms do a very good job handling garbage collections. If memory usage issues unrelated to memory leaks develop within an application, it should be dealt with JVM options rather than within the code itself.
ExplicitHashMapInstantiation.description=This rule checks for the explicit instantiation of a HashMap using the no-arg constructor. In Groovy, it is best to write "new HashMap()" as "[:]", which creates the same object.
ExplicitHashMapInstantiation.description.html=This rule checks for the explicit instantiation of a HashMap using the no-arg constructor. In Groovy, it is best to write new HashMap() as [:], which creates the same object.
ExplicitLinkedHashMapInstantiation.description=This rule checks for the explicit instantiation of a LinkedHashMap using the no-arg constructor. In Groovy, it is best to write "new LinkedHashMap()" as "[:]", which creates the same object.
ExplicitLinkedHashMapInstantiation.description.html=This rule checks for the explicit instantiation of a LinkedHashMap using the no-arg constructor. In Groovy, it is best to write new LinkedHashMap() as [:], which creates the same object.
ExplicitHashSetInstantiation.description=This rule checks for the explicit instantiation of a HashSet using the no-arg constructor. In Groovy, it is best to write "new HashSet()" as "[] as Set", which creates the same object.
ExplicitHashSetInstantiation.description.html=This rule checks for the explicit instantiation of a HashSet using the no-arg constructor. In Groovy, it is best to write new HashSet() as [] as Set, which creates the same object.
ExplicitLinkedListInstantiation.description=This rule checks for the explicit instantiation of a LinkedList using the no-arg constructor. In Groovy, it is best to write "new LinkedList()" as "[] as Queue", which creates the same object.
ExplicitLinkedListInstantiation.description.html=This rule checks for the explicit instantiation of a LinkedList using the no-arg constructor. In Groovy, it is best to write new LinkedList() as [] as Queue, which creates the same object.
ExplicitStackInstantiation.description=This rule checks for the explicit instantiation of a Stack using the no-arg constructor. In Groovy, it is best to write "new Stack()" as "[] as Stack", which creates the same object.
ExplicitStackInstantiation.description.html=This rule checks for the explicit instantiation of a Stack using the no-arg constructor. In Groovy, it is best to write new Stack() as [] as Stack, which creates the same object.
ExplicitTreeSetInstantiation.description=This rule checks for the explicit instantiation of a TreeSet using the no-arg constructor. In Groovy, it is best to write "new TreeSet()" as "[] as SortedSet", which creates the same object.
ExplicitTreeSetInstantiation.description.html=This rule checks for the explicit instantiation of a TreeSet using the no-arg constructor. In Groovy, it is best to write new TreeSet() as [] as SortedSet, which creates the same object.
ForLoopShouldBeWhileLoop.description=A for loop without an init and update statement can be simplified to a while loop.
ForLoopShouldBeWhileLoop.description.html=A for loop without an init and update statement can be simplified to a while loop.
GStringAsMapKey.description=A GString should not be used as a map key since its hashcode is not guaranteed to be stable. Consider calling key.toString().
GStringAsMapKey.description.html=A GString should not be used as a map key since its hashcode is not guaranteed to be stable. Consider calling key.toString().
InvertedIfElse.description=An inverted if-else statement is one in which there is a single if statement with a single else branch and the boolean test of the if is negated. For instance "if (!x) false else true". It is usually clearer to write this as "if (x) true else false".
InvertedIfElse.description.html=An inverted if-else statement is one in which there is a single if statement with a single else branch and the boolean test of the if is negated. For instance if (!x) false else true. It is usually clearer to write this as if (x) true else false.
RemoveAllOnSelf.description=Don't use removeAll to clear a collection. If you want to remove all elements from a collection c, use c.clear, not c.removeAll(c). Calling c.removeAll(c) to clear a collection is less clear, susceptible to errors from typos, less efficient and for some collections, might throw a ConcurrentModificationException.
RemoveAllOnSelf.description.html=Don't use removeAll to clear a collection. If you want to remove all elements from a collection c, use c.clear, not c.removeAll(c). Calling c.removeAll(c) to clear a collection is less clear, susceptible to errors from typos, less efficient and for some collections, might throw a ConcurrentModificationException.
ReturnFromFinallyBlock.description=Returning from a finally block is confusing and can hide the original exception.
ReturnFromFinallyBlock.description.html=Returning from a finally block is confusing and can hide the original exception.
ReturnsNullInsteadOfEmptyArray.description=Consider returning a zero length array rather than null. It is often a better design to return a length zero array rather than a null reference to indicate that there are no results (i.e., an empty list of results). This way, no explicit check for null is needed by clients of the method.
ReturnsNullInsteadOfEmptyArray.description.html=Consider returning a zero length array rather than null. It is often a better design to return a length zero array rather than a null reference to indicate that there are no results (i.e., an empty list of results). This way, no explicit check for null is needed by clients of the method.
ReturnsNullInsteadOfEmptyCollection.description=Consider returning a zero length collection rather than null. It is often a better design to return a length zero collection rather than a null reference to indicate that there are no results (i.e., an empty list of results). This way, no explicit check for null is needed by clients of the method.
ReturnsNullInsteadOfEmptyCollection.description.html=Consider returning a zero length collection rather than null. It is often a better design to return a length zero collection rather than a null reference to indicate that there are no results (i.e., an empty list of results). This way, no explicit check for null is needed by clients of the method.
SerialVersionUID.description=A serialVersionUID is normally intended to be used with Serialization. It needs to be of type long, static, and final. Also, it should have a visibility modifier such as public or private. Providing no modifier creates a Property and Groovy generates a getter, which is probably not intended.
SerialVersionUID.description.html=A serialVersionUID is normally intended to be used with Serialization. It needs to be of type long, static, and final. Also, it should have a visibility modifier such as public or private. Providing no modifier creates a Property and Groovy generates a getter, which is probably not intended.
SimpleDateFormatMissingLocale.description=Be sure to specify a Locale when creating a new instance of SimpleDateFormat; the class is locale-sensitive. If you instantiate SimpleDateFormat without a Locale parameter, it will format the date and time according to the default Locale. Both the pattern and the Locale determine the format. For the same pattern, SimpleDateFormat may format a date and time differently if the Locale varies.
SimpleDateFormatMissingLocale.description.html=Be sure to specify a Locale when creating a new instance of SimpleDateFormat; the class is locale-sensitive. If you instantiate SimpleDateFormat without a Locale parameter, it will format the date and time according to the default Locale. Both the pattern and the Locale determine the format. For the same pattern, SimpleDateFormat may format a date and time differently if the Locale varies.
ThrowExceptionFromFinallyBlock.description=Throwing an exception from a finally block is confusing and can hide the original exception.
ThrowExceptionFromFinallyBlock.description.html=Throwing an exception from a finally block is confusing and can hide the original exception.
UnsafeCallToNegativeOffset.description=This possible warns of referencing the element at the index of -1 in an Array or List. It is possible to get the last element of a list by calling list[-1], however an empty list will throw an exception for this operation. It is usually better to use the last() method on the list or array to access the last element. The last() method returns the last element of the collection or null if not found.
UnsafeCallToNegativeOffset.description.html=This possible warns of referencing the element at the index of -1 in an Array or List. It is possible to get the last element of a list by calling list[-1], however an empty list will throw an exception for this operation. It is usually better to use the last() method on the list or array to access the last element. The last() method returns the last element of the collection or null if not found.
UseCollectMany.description=In many case collectMany() yields the same result as collect{}.flatten(). It is easier to understand and more clearly conveys the intent.
UseCollectMany.description.html=In many case collectMany() yields the same result as collect{}.flatten(). It is easier to understand and more clearly conveys the intent.
UseCollectNested.description=Instead of nested collect{}-calls use collectNested{}
UseCollectNested.description.html=Instead of nested collect{}-calls use collectNested{}
ClosureAsLastMethodParameter.description=If a method is called and the last parameter is an inline closure then it can be declared outside of the method call brackets.
ClosureAsLastMethodParameter.description.html=If a method is called and the last parameter is an inline closure then it can be declared outside of the method call brackets.
ElseBlockBraces.description=Use braces for else blocks, even for a single statement. By default, braces are not required for an else if it is followed immediately by an if. Set the bracesRequiredForElseIf property to true to require braces is that situation as well.
ElseBlockBraces.description.html=Use braces for else blocks, even for a single statement. By default, braces are not required for an else if it is followed immediately by an if. Set the bracesRequiredForElseIf property to true to require braces is that situation as well.
ForStatementBraces.description=Use braces for for statements, even for a single statement.
ForStatementBraces.description.html=Use braces for for statements, even for a single statement.
IfStatementBraces.description=Use braces for if statements, even for a single statement.
IfStatementBraces.description.html=Use braces for if statements, even for a single statement.
WhileStatementBraces.description=Use braces for while statements, even for a single statement.
WhileStatementBraces.description.html=Use braces for while statements, even for a single statement.
NestedSynchronization.description=Nested synchronized statements should be avoided. Nested synchronized statements are either useless (if the lock objects are identical) or prone to deadlock.
NestedSynchronization.description.html=Nested synchronized statements should be avoided. Nested synchronized statements are either useless (if the lock objects are identical) or prone to deadlock.
SynchronizedMethod.description=This rule reports uses of the synchronized keyword on methods. Synchronized methods are the same as synchronizing on 'this', which effectively make your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
SynchronizedMethod.description.html=This rule reports uses of the synchronized keyword on methods. Synchronized methods are the same as synchronizing on 'this', which effectively make your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
SynchronizedOnGetClass.description=Synchronization on getClass rather than class literal. This instance method synchronizes on this.getClass(). If this class is subclassed, subclasses will synchronize on the class object for the subclass, which isn't likely what was intended.
SynchronizedOnGetClass.description.html=Synchronization on getClass rather than class literal. This instance method synchronizes on this.getClass(). If this class is subclassed, subclasses will synchronize on the class object for the subclass, which isn't likely what was intended.
SynchronizedOnThis.description=This rule reports uses of the synchronized blocks where the synchronization reference is 'this'. Doing this effectively makes your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
SynchronizedOnThis.description.html=This rule reports uses of the synchronized blocks where the synchronization reference is 'this'. Doing this effectively makes your synchronization policy public and modifiable by other objects. To avoid possibilities of deadlock, it is better to synchronize on internal objects.
SystemRunFinalizersOnExit.description=Method calls to System.runFinalizersOnExit() should not be allowed. This method is inherently non-thread-safe, may result in data corruption, deadlock, and may effect parts of the program far removed from it's call point. It is deprecated, and it's use strongly discouraged.
SystemRunFinalizersOnExit.description.html=Method calls to System.runFinalizersOnExit() should not be allowed. This method is inherently non-thread-safe, may result in data corruption, deadlock, and may effect parts of the program far removed from it's call point. It is deprecated, and it's use strongly discouraged.
ThreadYield.description=Method calls to Thread.yield() should not be allowed. This method has no useful guaranteed semantics, and is often used by inexperienced programmers to mask race conditions.
ThreadYield.description.html=Method calls to Thread.yield() should not be allowed. This method has no useful guaranteed semantics, and is often used by inexperienced programmers to mask race conditions.
ThreadLocalNotStaticFinal.description=ThreadLocal fields should be static and final. In the most common case a java.lang.ThreadLocal instance associates state with a thread. A non-static non-final java.lang.ThreadLocal field associates state with an instance-thread combination. This is seldom necessary and often a bug which can cause memory leaks and possibly incorrect behavior.
ThreadLocalNotStaticFinal.description.html=ThreadLocal fields should be static and final. In the most common case a java.lang.ThreadLocal instance associates state with a thread. A non-static non-finaljava.lang.ThreadLocal field associates state with an instance-thread combination. This is seldom necessary and often a bug which can cause memory leaks and possibly incorrect behavior.
UseOfNotifyMethod.description=This code calls notify() rather than notifyAll(). Java monitors are often used for multiple conditions. Calling notify() only wakes up one thread, meaning that the thread woken up might not be the one waiting for the condition that the caller just satisfied.
UseOfNotifyMethod.description.html=This code calls notify() rather than notifyAll(). Java monitors are often used for multiple conditions. Calling notify() only wakes up one thread, meaning that the thread woken up might not be the one waiting for the condition that the caller just satisfied.
VolatileLongOrDoubleField.description=Long or double fields should not be declared as volatile. Java specifies that reads and writes from such fields are atomic, but many JVM's have violated this specification. Unless you are certain of your JVM, it is better to synchronize access to such fields rather than declare them volatile. This rule flags fields marked volatile when their type is double or long or the name of their type is "Double" or "Long".
VolatileLongOrDoubleField.description.html=Long or double fields should not be declared as volatile. Java specifies that reads and writes from such fields are atomic, but many JVM's have violated this specification. Unless you are certain of your JVM, it is better to synchronize access to such fields rather than declare them volatile. This rule flags fields marked volatile when their type is double or long or the name of their type is "Double" or "Long".
AbstractClassWithoutAbstractMethod.description=The abstract class does not contain any abstract methods. An abstract class suggests an incomplete implementation, which is to be completed by subclasses implementing the abstract methods. If the class is intended to be used as a base class only (not to be instantiated direcly) a protected constructor can be provided prevent direct instantiation.
AbstractClassWithoutAbstractMethod.description.html=The abstract class does not contain any abstract methods. An abstract class suggests an incomplete implementation, which is to be completed by subclasses implementing the abstract methods. If the class is intended to be used as a base class only (not to be instantiated direcly) a protected constructor can be provided prevent direct instantiation.
CloseWithoutCloseable.description=If a class defines a "void close()" then that class should implement java.io.Closeable.
CloseWithoutCloseable.description.html=If a class defines a "void close()" then that class should implement java.io.Closeable.
ConstantsOnlyInterface.description=An interface should be used only to model a behaviour of a class: using an interface as a container of constants is a poor usage pattern.
ConstantsOnlyInterface.description.html=An interface should be used only to model a behaviour of a class: using an interface as a container of constants is a poor usage pattern.
EmptyMethodInAbstractClass.description=An empty method in an abstract class should be abstract instead, as developer may rely on this empty implementation rather than code the appropriate one.
EmptyMethodInAbstractClass.description.html=An empty method in an abstract class should be abstract instead, as developer may rely on this empty implementation rather than code the appropriate one.
FinalClassWithProtectedMember.description=This rule finds classes marked final that contain protected methods. If a class is final then it may not be subclassed, and there is therefore no point in having a method with protected visibility. Either the class should not be final or the method should be private or protected.
FinalClassWithProtectedMember.description.html=This rule finds classes marked final that contain protected methods. If a class is final then it may not be subclassed, and there is therefore no point in having a method with protected visibility. Either the class should not be final or the method should be private or protected.
ImplementationAsType.description=Checks for use of a predefined set of concrete classes (e.g. ArrayList, Hashtable, ConcurrentHashMap) when specifying the type of a method parameter, closure parameter, constructor parameter, method return type or field type. The associated interfaces should be used to specify the type instead.
ImplementationAsType.description.html=Checks for use of a predefined set of concrete classes (e.g. ArrayList, Hashtable, ConcurrentHashMap) when specifying the type of a method parameter, closure parameter, constructor parameter, method return type or field type. The associated interfaces should be used to specify the type instead.
DuplicateNumberLiteral.description=Code containing duplicate number literals can usually be improved by declaring the number as a constant field. The ignoreNumbers property (${rule.ignoreNumbers}) can optionally specify a comma-separated list of numbers to ignore.
DuplicateNumberLiteral.description.html=Code containing number String literals can usually be improved by declaring the number as a constant field. The ignoreNumbers property (${rule.ignoreNumbers}) can optionally specify a comma-separated list of numbers to ignore.
DuplicateStringLiteral.description=Code containing duplicate String literals can usually be improved by declaring the String as a constant field. The ignoreStrings property (${rule.ignoreStrings}) can optionally specify a comma-separated list of Strings to ignore.
DuplicateStringLiteral.description.html=Code containing duplicate String literals can usually be improved by declaring the String as a constant field. The ignoreStrings property (${rule.ignoreStrings}) can optionally specify a comma-separated list of Strings to ignore.
DuplicateListLiteral.description=Code containing duplicate List literals can usually be improved by declaring the List as a constant field.
DuplicateListLiteral.description.html=Code containing duplicate List literals can usually be improved by declaring the List as a constant field.
DuplicateMapLiteral.description=Code containing duplicate Map literals can usually be improved by declaring the Map as a constant field.
DuplicateMapLiteral.description.html=Code containing duplicate Map literals can usually be improved by declaring the Map as a constant field.
CatchArrayIndexOutOfBoundsException.description=Check the size of the array before accessing an array element rather than catching ArrayIndexOutOfBoundsException.
CatchArrayIndexOutOfBoundsException.description.html=Check the size of the array before accessing an array element rather than catching ArrayIndexOutOfBoundsException.
CatchError.description=Catching Error is dangerous; it can catch exceptions such as ThreadDeath and OutOfMemoryError.
CatchError.description.html=Catching Error is dangerous; it can catch exceptions such as ThreadDeath and OutOfMemoryError.
CatchException.description=Catching Exception is often too broad or general. It should usually be restricted to framework or infrastructure code, rather than application code.
CatchException.description.html=Catching Exception is often too broad or general. It should usually be restricted to framework or infrastructure code, rather than application code.
CatchIllegalMonitorStateException.description=Dubious catching of IllegalMonitorStateException. IllegalMonitorStateException is generally only thrown in case of a design flaw in your code (calling wait or notify on an object you do not hold a lock on).
CatchIllegalMonitorStateException.description.html=Dubious catching of IllegalMonitorStateException. IllegalMonitorStateException is generally only thrown in case of a design flaw in your code (calling wait or notify on an object you do not hold a lock on).
CatchIndexOutOfBoundsException.description=Check that an index is valid before accessing an indexed element rather than catching IndexOutOfBoundsException.
CatchIndexOutOfBoundsException.description.html=Check that an index is valid before accessing an indexed element rather than catching IndexOutOfBoundsException.
CatchNullPointerException.description=Catching NullPointerException is never appropriate. It should be avoided in the first place with proper null checking, and it can mask underlying errors.
CatchNullPointerException.description.html=Catching NullPointerException is never appropriate. It should be avoided in the first place with proper null checking, and it can mask underlying errors.
CatchRuntimeException.description=Catching RuntimeException is often too broad or general. It should usually be restricted to framework or infrastructure code, rather than application code.
CatchRuntimeException.description.html=Catching RuntimeException is often too broad or general. It should usually be restricted to framework or infrastructure code, rather than application code.
CatchThrowable.description=Catching Throwable is dangerous; it can catch exceptions such as ThreadDeath and OutOfMemoryError.
CatchThrowable.description.html=Catching Throwable is dangerous; it can catch exceptions such as ThreadDeath and OutOfMemoryError.
ConfusingClassNamedException.description=This class is not derived from another exception, but ends with 'Exception'. This will be confusing to users of this class.
ConfusingClassNamedException.description.html=This class is not derived from another exception, but ends with 'Exception'. This will be confusing to users of this class.
ExceptionExtendsError.description=Errors are system exceptions. Do not extend them.
ExceptionExtendsError.description.html=Errors are system exceptions. Do not extend them.
MissingNewInThrowStatement.description=A common Groovy mistake when throwing exceptions is to forget the new keyword. For instance, "throw RuntimeException()" instead of "throw new RuntimeException()". If the error path is not unit tested then the production system will throw a Method Missing exception and hide the root cause. This rule finds constructs like "throw RuntimeException()" that look like a new keyword was meant to be used but forgotten.
MissingNewInThrowStatement.description.html=A common Groovy mistake when throwing exceptions is to forget the new keyword. For instance, "throw RuntimeException()" instead of "throw new RuntimeException()". If the error path is not unit tested then the production system will throw a Method Missing exception and hide the root cause. This rule finds constructs like "throw RuntimeException()" that look like a new keyword was meant to be used but forgotten.
ReturnNullFromCatchBlock.description=Returning null from a catch block often masks errors and requires the client to handle error codes. In some coding styles this is discouraged.
ReturnNullFromCatchBlock.description.html=Returning null from a catch block often masks errors and requires the client to handle error codes. In some coding styles this is discouraged.
ThrowError.description=Checks for throwing an instance of java.lang.Error.
ThrowError.description.html=Checks for throwing an instance of java.lang.Error.
ThrowException.description=Checks for throwing an instance of java.lang.Exception.
ThrowException.description.html=Checks for throwing an instance of java.lang.Exception.
ThrowNullPointerException.description=Checks for throwing an instance of java.lang.NullPointerException.
ThrowNullPointerException.description.html=Checks for throwing an instance of java.lang.NullPointerException.
ThrowRuntimeException.description=Checks for throwing an instance of java.lang.RuntimeException.
ThrowRuntimeException.description.html=Checks for throwing an instance of java.lang.RuntimeException.
ThrowThrowable.description=Checks for throwing an instance of java.lang.Throwable.
ThrowThrowable.description.html=Checks for throwing an instance of java.lang.Throwable.
IllegalRegex.description=Checks for a specified illegal regular expression within the source code. The regex property specifies the regular expression to check for. It is required and cannot be null or empty.
IllegalRegex.description.html=Checks for a specified illegal regular expression within the source code. The regex property specifies the regular expression to check for. It is required and cannot be null or empty.
RequiredRegex.description=Checks for a specified regular expression that must exist within the source code. The regex property specifies the regular expression to check for. It is required and cannot be null or empty.
RequiredRegex.description.html=Checks for a specified regular expression that must exist within the source code. The regex property specifies the regular expression to check for. It is required and cannot be null or empty.
RequiredString.description=Checks for a specified text string that must exist within the source code. The string property specifies the String to check for. It is required and cannot be null or empty.
RequiredString.description.html=Checks for a specified text string that must exist within the source code. The string property specifies the String to check for. It is required and cannot be null or empty.
StatelessClass.description=Checks for fields on classes that should remain "stateless" and reentrant. The ignoreFieldNames property (${rule.ignoreFieldNames}) specifies one or more field names that should be ignored. The ignoreFieldTypes property specifies one or more field type names that should be ignored. Both can optionally contain wildcard characters ('*' or '?').
StatelessClass.description.html=Checks for fields on classes that should remain "stateless" and reentrant. The ignoreFieldNames property (${rule.ignoreFieldNames}) specifies one or more field names that should be ignored. The ignoreFieldTypes property specifies one or more field type names that should be ignored. Both can optionally contain wildcard characters ('*' or '?').
GrailsPublicControllerMethod.description=Checks for public methods on Grails controller classes. Static methods are ignored.
GrailsPublicControllerMethod.description.html=Checks for public methods on Grails controller classes. Static methods are ignored.
GrailsSessionReference.description=Checks for references to the session object from within Grails controller and taglib classes. [DEPRECATED]
GrailsSessionReference.description.html=Checks for references to the session object from within Grails controller and taglib classes. [DEPRECATED]
GrailsServletContextReference.description=Checks for references to the servletContext object from within Grails controller and taglib classes.
GrailsServletContextReference.description.html=Checks for references to the servletContext object from within Grails controller and taglib classes.
GrailsStatelessService.description=Checks for fields on Grails service classes. Grails service classes are singletons, by default, and so they should be reentrant and typically stateless. The ignoreFieldNames property (${rule.ignoreFieldNames}) specifies one or more field names that should be ignored. The ignoreFieldTypes property (${rule.ignoreFieldTypes}) specifies one or more field type names that should be ignored. Both can optionally contain wildcard characters ('*' or '?').
GrailsStatelessService.description.html=Checks for fields on Grails service classes. Grails service classes are singletons, by default, and so they should be reentrant and typically stateless. The ignoreFieldNames property (${rule.ignoreFieldNames}) specifies one or more field names that should be ignored. The ignoreFieldTypes property (${rule.ignoreFieldTypes}) specifies one or more field type names that should be ignored. Both can optionally contain wildcard characters ('*' or '?').
DuplicateImport.description=Duplicate import statements are unnecessary.
DuplicateImport.description.html=Duplicate import statements are unnecessary.
UnnecessaryInstantiationToGetClass.description=Avoid instantiating an object just to call getClass() on it; use the .class public member instead.
UnnecessaryInstantiationToGetClass.description.html=Avoid instantiating an object just to call getClass() on it; use the .class public member instead.
ImportFromSamePackage.description=An import of a class that is within the same package is unnecessary.
ImportFromSamePackage.description.html=An import of a class that is within the same package is unnecessary.
UnnecessaryGroovyImport.description=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.
UnnecessaryGroovyImport.description.html=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.
UnusedImport.description=Imports for a class that is never referenced within the source file is unnecessary.
UnusedImport.description.html=Imports for a class that is never referenced within the source file is unnecessary.
MisorderedStaticImports.description=Static imports should never be declared after nonstatic imports.
MisorderedStaticImports.description.html=Static imports should never be declared after nonstatic imports.
NoWildcardImports.description=Wildcard imports, static or otherwise, should not be used.
NoWildcardImports.description.html=Wildcard imports, static or otherwise, should not be used.
JUnitSetUpCallsSuper.description=Checks that if the JUnit setUp() method is defined, that it includes a call to super.setUp().
JUnitSetUpCallsSuper.description.html=Checks that if the JUnit setUp() method is defined, that it includes a call to super.setUp().
JUnitTearDownCallsSuper.description=Checks that if the JUnit tearDown() method is defined, that it includes a call to super.tearDown().
JUnitTearDownCallsSuper.description.html=Checks that if the JUnit tearDown() method is defined, that it includes a call to super.tearDown().
JUnitAssertAlwaysFails.description=Checks for JUnit assert() method calls with constant arguments such that the assertion always fails. This includes: assertTrue(false), assertFalse(true) and assertNull(CONSTANT).
JUnitAssertAlwaysFails.description.html=Checks for JUnit assert() method calls with constant arguments such that the assertion always fails. This includes: assertTrue(false), assertFalse(true) and assertNull(CONSTANT).
JUnitAssertAlwaysSucceeds.description=Checks for JUnit assert() method calls with constant arguments such that the assertion always succeeds. This includes: assertTrue(true), assertFalse(false) and assertNull(null).
JUnitAssertAlwaysSucceeds.description.html=Checks for JUnit assert() method calls with constant arguments such that the assertion always succeeds. This includes: assertTrue(true), assertFalse(false) and assertNull(null).
JUnitAssertEqualsConstantActualValue.description=Reports usages of org.junit.Assert.assertEquals([message,] expected, actual) where the 'actual' parameter is a constant or a literal. Most likely it was intended to be the 'expected' value.
JUnitAssertEqualsConstantActualValue.description.html=Reports usages of org.junit.Assert.assertEquals([message,] expected, actual) where the 'actual' parameter is a constant or a literal. Most likely it was intended to be the 'expected' value.
JUnitPublicNonTestMethod.description=Checks if a JUnit test class contains public methods other than standard test methods, JUnit framework methods or methods with JUnit annotations.
JUnitPublicNonTestMethod.description.html=Checks if a JUnit test class contains public methods other than standard test methods, JUnit framework methods or methods with JUnit annotations.
JUnitStyleAssertions.description=This rule detects calling JUnit style assertions like assertEquals, assertTrue, assertFalse, assertNull, assertNotNull. Groovy 1.7 ships with a feature called the "power assert", which is an assert statement with better error reporting. This is preferable to the JUnit assertions.
JUnitStyleAssertions.description.html=This rule detects calling JUnit style assertions like assertEquals, assertTrue, assertFalse, assertNull, assertNotNull. Groovy 1.7 ships with a feature called the "power assert", which is an assert statement with better error reporting. This is preferable to the JUnit assertions.
JUnitUnnecessarySetUp.description=Checks for JUnit setUp() methods that contain only a call to super.setUp().
JUnitUnnecessarySetUp.description.html=Checks for JUnit setUp() methods that contain only a call to super.setUp().
JUnitUnnecessaryTearDown.description=Checks for JUnit tearDown() methods that contain only a call to super.tearDown().
JUnitUnnecessaryTearDown.description.html=Checks for JUnit tearDown() methods that contain only a call to super.tearDown().
UseAssertEqualsInsteadOfAssertTrue.description=This rule detects JUnit assertions in object equality. These assertions should be made by more specific methods, like assertEquals.
UseAssertEqualsInsteadOfAssertTrue.description.html=This rule detects JUnit assertions in object equality. These assertions should be made by more specific methods, like assertEquals.
UseAssertNullInsteadOfAssertEquals.description=This rule detects JUnit calling assertEquals where the first or second parameter is null. These assertion should be made against the assertNull method instead.
UseAssertNullInsteadOfAssertEquals.description.html=This rule detects JUnit calling assertEquals where the first or second parameter is null. These assertion should be made against the assertNull method instead.
UseAssertSameInsteadOfAssertTrue.description=This rule detects JUnit calling assertTrue where the first or second parameter is an Object#is() call testing for reference equality. These assertion should be made against the assertSame method instead.
UseAssertSameInsteadOfAssertTrue.description.html=This rule detects JUnit calling assertTrue where the first or second parameter is an Object#is() call testing for reference equality. These assertion should be made against the assertSame method instead.
UseAssertFalseInsteadOfNegation.description=In unit tests, if a condition is expected to be false then there is no sense using assertTrue with the negation operator. For instance, assertTrue(!condition) can always be simplified to assertFalse(condition)
UseAssertFalseInsteadOfNegation.description.html=In unit tests, if a condition is expected to be false then there is no sense using assertTrue with the negation operator. For instance, assertTrue(!condition) can always be simplified to assertFalse(condition)
UseAssertTrueInsteadOfAssertEquals.description=This rule detects JUnit calling assertEquals where the first parameter is a boolean. These assertions should be made by more specific methods, like assertTrue or assertFalse.
UseAssertTrueInsteadOfAssertEquals.description.html=This rule detects JUnit calling assertEquals where the first parameter is a boolean. These assertions should be made by more specific methods, like assertTrue or assertFalse.
UseAssertTrueInsteadOfNegation.description=In unit tests, if a condition is expected to be true then there is no sense using assertFalse with the negation operator. For instance, assertFalse(!condition) can always be simplified to assertTrue(condition)
UseAssertTrueInsteadOfNegation.description.html=In unit tests, if a condition is expected to be true then there is no sense using assertFalse with the negation operator. For instance, assertFalse(!condition) can always be simplified to assertTrue(condition)
JUnitFailWithoutMessage.description=This rule detects JUnit calling the fail() method without an argument. For better error reporting you should always provide a message.
JUnitFailWithoutMessage.description.html=This rule detects JUnit calling the fail() method without an argument. For better error reporting you should always provide a message.
JUnitTestMethodWithoutAssert.description=This rule searches for test methods that do not contain assert statements. Either the test method is missing assert statements, which is an error, or the test method contains custom assert statements that do not follow a proper assert naming convention. Test methods are defined as public void methods that begin with the work test or have a @Test annotation. By default this rule applies to the default test class names, but this can be changed using the rule's applyToClassNames property.
JUnitTestMethodWithoutAssert.description.html=This rule searches for test methods that do not contain assert statements. Either the test method is missing assert statements, which is an error, or the test method contains custom assert statements that do not follow a proper assert naming convention. Test methods are defined as public void methods that begin with the work test or have a @Test annotation. By default this rule applies to the default test class names, but this can be changed using the rule's applyToClassNames property.
LoggerForDifferentClass.description=Checks for instantiating a logger (Log4J, SLF4J, Logback, Apache Commons Logging or Java Util Logging) for a class other than the current class.
LoggerForDifferentClass.description.html=Checks for instantiating a logger (Log4J, SLF4J, Logback, Apache Commons Logging or Java Util Logging) for a class other than the current class.
LoggingSwallowsStacktrace.description=If you are logging an exception then the proper API is to call error(Object, Throwable), which will log the message and the exception stack trace. If you call error(Object) then the stacktrace may not be logged.
LoggingSwallowsStacktrace.description.html=If you are logging an exception then the proper API is to call error(Object, Throwable), which will log the message and the exception stack trace. If you call error(Object) then the stacktrace may not be logged.
LoggerWithWrongModifiers.description=Logger objects should be declared private, static and final. If subclasses should have access to a Logger in a parent class then the Logger should be declared protected, non-static and final. This rule find loggers that are not declared with these modifiers.
LoggerWithWrongModifiers.description.html=Logger objects should be declared private, static and final. If subclasses should have access to a Logger in a parent class then the Logger should be declared protected, non-static and final. This rule find loggers that are not declared with these modifiers.
MultipleLoggers.description=This rule catches classes that have more than one logger object defined. Typically, a class has zero or one logger objects.
MultipleLoggers.description.html=This rule catches classes that have more than one logger object defined. Typically, a class has zero or one logger objects.
PrintStackTrace.description=Checks for calls to printStackTrace().
PrintStackTrace.description.html=Checks for calls to printStackTrace().
Println.description=Checks for calls to this.print(), this.println() or this.printf().
Println.description.html=Checks for calls to this.print(), this.println() or this.printf().
SystemErrPrint.description=Checks for calls to System.err.print(), System.err.println() or System.err.printf().
SystemErrPrint.description.html=Checks for calls to System.err.print(), System.err.println() or System.err.printf().
SystemOutPrint.description=Checks for calls to System.out.print(), System.out.println() or System.out.printf().
SystemOutPrint.description.html=Checks for calls to System.out.print(), System.out.println() or System.out.printf().
AbstractClassName.description=Verifies that the name of an abstract class matches a regular expression specified in the regex property. If that property is null or empty, then this rule is not applied (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active. This rule ignores interfaces.
AbstractClassName.description.html=Verifies that the name of an abstract class matches a regular expression specified in the regex property. If that property is null or empty, then this rule is not applied (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active. This rule ignores interfaces.
ClassName.description=Verifies that the name of a class matches a regular expression. By default it checks that the class name starts with an uppercase letter and is followed by zero or more word characters (letters, numbers or underscores). The regex property specifies the regular expression used to validate the class name.
ClassName.description.html=Verifies that the name of a class matches a regular expression. By default it checks that the class name starts with an uppercase letter and is followed by zero or more word characters (letters, numbers or underscores). The regex property specifies the regular expression used to validate the class name.
ClassNameSameAsFilename.description=Reports files containing only one top level class / enum / interface which is named differently than the file.
ClassNameSameAsFilename.description.html=Reports files containing only one top level class / enum / interface which is named differently than the file.
FieldName.description=Verifies that the name of each field matches a regular expression. By default it checks that non-'final' field names start with a lowercase letter and contains only letters or numbers, and 'final' field names start with an uppercase letter and contain only uppercase letters, numbers and underscores. The regex property specifies the default regular expression used to validate field names. The finalRegex property specifies the regular expression to validate 'final' field names. The staticRegex property specifies the regular expression to validate 'static' field names. The staticFinalRegex property specifies the regular expression to validate 'static final' field names. The ignoreFieldNames property (${rule.ignoreFieldNames}) can specify field names that should be ignored, optionally containing wildcard characters ('*' or '?').
FieldName.description.html=Verifies that the name of each field matches a regular expression. By default it checks that non-'final' field names start with a lowercase letter and contains only letters or numbers, and 'final' field names start with an uppercase letter and contain only uppercase letters, numbers and underscores. The regex property specifies the default regular expression used to validate field names. The finalRegex property specifies the regular expression to validate 'final' field names. The staticRegex property specifies the regular expression to validate 'static' field names. The staticFinalRegex property specifies the regular expression to validate 'static final' field names. The ignoreFieldNames property (${rule.ignoreFieldNames})can specify field names that should be ignored, optionally containing wildcard characters ('*' or '?').
InterfaceName.description=Verifies that the name of an interface matches a regular expression specified in the regex property. If that property is null or empty, then this rule is not applied (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active.
InterfaceName.description.html=Verifies that the name of an interface matches a regular expression specified in the regex property. If that property is null or empty, then this rule is not applied (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active.
MethodName.description=Verifies that the name of each method matches a regular expression. By default it checks that the method name starts with a lowercase letter. The regex property specifies the regular expression to check the method name against. The ignoreMethodNames property (${rule.ignoreMethodNames}) can specify method names that should be ignored, optionally containing wildcard characters ('*' or '?').
MethodName.description.html=Verifies that the name of each method matches a regular expression. By default it checks that the method name starts with a lowercase letter. The regex property specifies the regular expression to check the method name against. The ignoreMethodNames property (${rule.ignoreMethodNames}) can specify method names that should be ignored, optionally containing wildcard characters ('*' or '?').
ObjectOverrideMisspelledMethodName.description=Verifies that the names of the most commonly overridden methods of Object: equals, hashCode and toString, are correct.
ObjectOverrideMisspelledMethodName.description.html=Verifies that the names of the most commonly overridden methods of Object: equals, hashCode and toString, are correct.
PackageName.description=Verifies that the package name for a class matches a regular expression. By default it checks that the package name consists of only lowercase letters, separated by periods. The regex property specifies the regular expression used to validate the package name. The packageNameRequired property indicates whether a package name declaration is required for all classes.
PackageName.description.html=Verifies that the package name for a class matches a regular expression. By default it checks that the package name consists of only lowercase letters, separated by periods. The regex property specifies the regular expression used to validate the package name. The packageNameRequired property indicates whether a package name declaration is required for all classes.
PackageNameMatchesFilePath.description=A package source file's path should match the package itself. To find the package-relevant subpath in the file path the groupId needs to be configured. It is expected in every package declaration.
PackageNameMatchesFilePath.description.html=A package source file's path should match the package itself. To find the package-relevant subpath in the file path the groupIdneeds to be configured. It is expected in every package declaration.
ParameterName.description=Verifies that the name of each parameter matches a regular expression. This rule applies to method parameters, constructor parameters and closure parameters. By default it checks that parameter names start with a lowercase letter and contains only letters or numbers. The regex property specifies the default regular expression used to validate the parameter name. The ignoreParameterNames property (${rule.ignoreParameterNames}) can specify parameter names that should be ignored, optionally containing wildcard characters ('*' or '?').
ParameterName.description.html=Verifies that the name of each parameter matches a regular expression. This rule applies to method parameters, constructor parameters and closure parameters. By default it checks that parameter names start with a lowercase letter and contains only letters or numbers. The regex property specifies the default regular expression used to validate the parameter name. The ignoreParameterNames property (${rule.ignoreParameterNames}) can specify parameter names that should be ignored, optionally containing wildcard characters ('*' or '?').
VariableName.description=Verifies that the name of each method matches a regular expression. By default it checks that non-'final' variable names start with a lowercase letter and contains only letters or numbers, and 'final' variable names start with an uppercase letter and contain only uppercase letters, numbers and underscores. The regex property specifies the default regular expression used to validate a non-'final' variable name. The finalRegex property specifies the regular expression used to validate 'final' variable names. The ignoreVariableNames property (${rule.ignoreVariableNames}) can specify variable names that should be ignored, optionally containing wildcard characters ('*' or '?').
VariableName.description.html=Verifies that the name of each method matches a regular expression. By default it checks that non-'final' variable names start with a lowercase letter and contains only letters or numbers, and 'final' variable names start with an uppercase letter and contain only uppercase letters, numbers and underscores. The regex property specifies the default regular expression used to validate a non-'final' variable name. The finalRegex property specifies the regular expression used to validate 'final' variable names. The ignoreVariableNames property (${rule.ignoreVariableNames}) can specify variable names that should be ignored, optionally containing wildcard characters ('*' or '?').
PropertyName.description=Verifies that the name of each property matches a regular expression. By default it checks that property names other than 'static final' start with a lowercase letter and contains only letters or numbers, and 'static final' property names start with an uppercase letter and contain only uppercase letters, numbers and underscores. The regex property specifies the default regular expression used to validate property names. The finalRegex property specifies the regular expression to validate 'final' property names. The staticRegex property specifies the regular expression to validate 'static' property names. The staticFinalRegex property specifies the regular expression to validate 'static final' property names. The ignorePropertyNames property (${rule.ignorePropertyNames}) can specify property names that should be ignored, optionally containing wildcard characters ('*' or '?').
PropertyName.description.html=Verifies that the name of each property matches a regular expression. By default it checks that property names other than 'static final' start with a lowercase letter and contains only letters or numbers, and 'static final' property names start with an uppercase letter and contain only uppercase letters, numbers and underscores. The regex property specifies the default regular expression used to validate property names. The finalRegex property specifies the regular expression to validate 'final' property names. The staticRegex property specifies the regular expression to validate 'static' property names. The staticFinalRegex property specifies the regular expression to validate 'static final' property names. The ignorePropertyNames property (${rule.ignorePropertyNames}) can specify property names that should be ignored, optionally containing wildcard characters ('*' or '?').
ConfusingMethodName.description=Checks for confusing method names. The referenced methods have names that differ only by capitalization. This is very confusing because if the capitalization were identical then one of the methods would override the other.
ConfusingMethodName.description.html=Checks for confusing method names. The referenced methods have names that differ only by capitalization. This is very confusing because if the capitalization were identical then one of the methods would override the other.
AbcComplexity.description=Checks the ABC metric of size/complexity for methods/classes.\
A method (or "closure field") with an ABC complexity value (score) greater than the maxMethodComplexity \
property (${rule.maxMethodComplexity}) causes a violation. Likewise, a class that has an (average method) ABC complexity\
value greater than the maxClassAverageMethodComplexity property (${rule.maxClassAverageMethodComplexity}) causes a violation. [DEPRECATED: Use AbcMetric rule instead]
AbcComplexity.description.html=Checks the ABC metric of size/complexity for methods/classes.\
A method (or "closure field") with an ABC complexity value (score) greater than the maxMethodComplexity \
property (${rule.maxMethodComplexity}) causes a violation. Likewise, a class that has an (average method) ABC complexity\
value greater than the maxClassAverageMethodComplexity property (${rule.maxClassAverageMethodComplexity}) causes a violation. [DEPRECATED: Use AbcMetric rule instead]
AbcMetric.description=Checks the ABC size metric for methods/classes. \
A method (or "closure field") with an ABC score greater than the maxMethodAbcScore \
property (${rule.maxMethodAbcScore}) causes a violation. Likewise, a class that has an (average method) ABC score \
greater than the maxClassAverageMethodAbcScore property (${rule.maxClassAverageMethodAbcScore}) causes a violation.
AbcMetric.description.html=Checks the ABC size metric for methods/classes. \
A method (or "closure field") with an ABC score greater than the maxMethodAbcScore \
property (${rule.maxMethodAbcScore}) causes a violation. Likewise, a class that has an (average method) ABC score \
greater than the maxClassAverageMethodAbcScore property (${rule.maxClassAverageMethodAbcScore}) causes a violation.
ClassSize.description=Checks if the size of a class exceeds the number of lines specified by the maxLines property (${rule.maxLines}).
ClassSize.description.html=Checks if the size of a class exceeds the number of lines specified by the maxLines property (${rule.maxLines}).
CyclomaticComplexity.description=Checks the cyclomatic complexity for methods/classes.\
A method (or "closure field") with a cyclomatic complexity value greater than the maxMethodComplexity \
property (${rule.maxMethodComplexity}) causes a violation. Likewise, a class that has an (average method) cyclomatic complexity\
value greater than the maxClassAverageMethodComplexity property (${rule.maxClassAverageMethodComplexity}) causes a violation.
CyclomaticComplexity.description.html=Checks the cyclomatic complexity for methods/classes.\
A method (or "closure field") with a cyclomatic complexity value greater than the maxMethodComplexity \
property (${rule.maxMethodComplexity}) causes a violation. Likewise, a class that has an (average method) cyclomatic complexity\
value greater than the maxClassAverageMethodComplexity property (${rule.maxClassAverageMethodComplexity}) causes a violation.
MethodCount.description=A class with too many methods is probably a good suspect for refactoring, in order to reduce its \
complexity and find a way to have more fine grained objects. The maxMethods property (${rule.maxMethods}) specifies the threshold.
MethodCount.description.html=A class with too many methods is probably a good suspect for refactoring, in order to reduce its \
complexity and find a way to have more fine grained objects.The maxMethods property (${rule.maxMethods}) specifies the threshold.
MethodSize.description=Checks if the size of a method exceeds the number of lines specified by the maxLines property (${rule.maxLines}).
MethodSize.description.html=Checks if the size of a method exceeds the number of lines specified by the maxLines property (${rule.maxLines}).
NestedBlockDepth.description=Checks for blocks or closures nested more than maxNestedBlockDepth (${rule.maxNestedBlockDepth}) levels deep.
NestedBlockDepth.description.html=Checks for blocks or closures nested more than maxNestedBlockDepth (${rule.maxNestedBlockDepth}) levels deep.
ParameterCount.description=Checks if the number of parameters in method/constructor exceeds the number of parameters specified by the maxParameters property.
ParameterCount.description.html=Checks if the number of parameters in method/constructor exceeds the number of parameters specified by the maxParameters property.
UnnecessaryBigDecimalInstantiation.description=It is unnecessary to instantiate BigDecimal objects. Instead just use the decimal literal or the 'G' identifier to force the type, such as 123.45 or 123.45G.
UnnecessaryBigDecimalInstantiation.description.html=It is unnecessary to instantiate BigDecimal objects. Instead just use the decimal literal or the 'G' identifier to force the type, such as 123.45 or 123.45G.
UnnecessaryBigIntegerInstantiation.description=It is unnecessary to instantiate BigInteger objects. Instead just use the literal with the 'G' identifier to force the type, such as 8G or 42G.
UnnecessaryBigIntegerInstantiation.description.html=It is unnecessary to instantiate BigInteger objects. Instead just use the literal with the 'G' identifier to force the type, such as 8G or 42G.
UnnecessaryBooleanExpression.description=Checks for unnecessary boolean expressions, including ANDing (&&) or ORing (||) with true, false, null, or a Map/List/String/Number literal. Also checks for negation (!) of true, false, null, or a Map/List/String/Number literal.
UnnecessaryBooleanExpression.description.html=Checks for unnecessary boolean expressions, including ANDing (&&) or ORing (||) with true, false, null, or a Map/List/String/Number literal. Also checks for negation (!) of true, false, null, or a Map/List/String/Number literal.
UnnecessaryBooleanInstantiation.description=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).
UnnecessaryBooleanInstantiation.description.html=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).
UnnecessaryCallForLastElement.description=This rule checks for excessively verbose methods of accessing the last element of an array or list. For instance, it is possible to access the last element of an array by performing array[array.length - 1], in Groovy it is simpler to either call array.last() or array[-1]. The same is true for lists. This violation is triggered whenever a get, getAt, or array-style access is used with an object size check.
UnnecessaryCallForLastElement.description.html=This rule checks for excessively verbose methods of accessing the last element of an array or list. For instance, it is possible to access the last element of an array by performing array[array.length - 1], in Groovy it is simpler to either call array.last() or array[-1]. The same is true for lists. This violation is triggered whenever a get, getAt, or array-style access is used with an object size check.
UnnecessaryConstructor.description=This rule detects when a constructor is not necessary; i.e., when there's only one constructor, it's public, has an empty body, and takes no arguments.
UnnecessaryConstructor.description.html=This rule detects when a constructor is not necessary; i.e., when there's only one constructor, it's public, has an empty body, and takes no arguments.
UnnecessaryDoubleInstantiation.description=It is unnecessary to instantiate Double objects. Instead just use the double literal or the 'D' identifier to force the type, such as 123.45d or 0.42d.
UnnecessaryDoubleInstantiation.description.html=It is unnecessary to instantiate Double objects. Instead just use the double literal or the 'D' identifier to force the type, such as 123.45d or 0.42d.
UnnecessaryFloatInstantiation.description=It is unnecessary to instantiate Float objects. Instead just use the float literal with the 'F' identifier to force the type, such as 123.45F or 0.42f.
UnnecessaryFloatInstantiation.description.html=It is unnecessary to instantiate Float objects. Instead just use the float literal with the 'F' identifier to force the type, such as 123.45F or 0.42f.
UnnecessaryGetter.description=Checks for explicit calls to getter/accessor methods which can, for the most part, be replaced by property access. A getter is defined as a method call that matches get[A-Z] but not getClass() or get[A-Z][A-Z] such as getURL(). Getters do not take method arguments.
UnnecessaryGetter.description.html=Checks for explicit calls to getter/accessor methods which can, for the most part, be replaced by property access. A getter is defined as a method call that matches get[A-Z] but not getClass() or get[A-Z][A-Z] such as getURL(). Getters do not take method arguments.
UnnecessaryIfStatement.description=Checks for if statements where the if and else blocks (or subsequent fall-through to a return), are merely returning true and false constants. These cases can be replaced by a simple return statement.
UnnecessaryIfStatement.description.html=Checks for if statements where the if and else blocks (or subsequent fall-through to a return) are merely returning true and false constants. These cases can be replaced by a simple return statement.
UnnecessaryNullCheck.description=Groovy contains the safe dereference operator, which can be used in boolean conditional statements to safely replace explicit "x == null" tests.
UnnecessaryNullCheck.description.html=Groovy contains the safe dereference operator, which can be used in boolean conditional statements to safely replace explicit "x == null" tests.
UnnecessaryNullCheckBeforeInstanceOf.description=There is no need to check for null before an instanceof; the instanceof keyword returns false when given a null argument.
UnnecessaryNullCheckBeforeInstanceOf.description.html=There is no need to check for null before an instanceof; the instanceof keyword returns false when given a null argument.
UnnecessaryObjectReferences.description=Violations are triggered when an excessive set of consecutive statements all reference the same variable. This can be made more readable by using a with or identity block.
UnnecessaryObjectReferences.description.html=Violations are triggered when an excessive set of consecutive statements all reference the same variable. This can be made more readable by using a with or identity block.
UnnecessaryTernaryExpression.description=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.
UnnecessaryTernaryExpression.description.html=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.
UnnecessaryReturnKeyword.description=In Groovy, the return keyword is often optional. If a statement is the last line in a method or closure then you do not need to have the return keyword.
UnnecessaryReturnKeyword.description.html=In Groovy, the return keyword is often optional. If a statement is the last line in a method or closure then you do not need to have the return keyword.
UnnecessaryIntegerInstantiation.description=It is unnecessary to instantiate Integer objects. Instead just use the literal with the 'I' identifier to force the type, such as 8I or 42i.
UnnecessaryIntegerInstantiation.description.html=It is unnecessary to instantiate Integer objects. Instead just use the literal with the 'I' identifier to force the type, such as 8I or 42i.
UnnecessaryLongInstantiation.description=It is unnecessary to instantiate Long objects. Instead just use the literal with the 'L' identifier to force the type, such as 8L or 42L.
UnnecessaryLongInstantiation.description.html=It is unnecessary to instantiate Long objects. Instead just use the literal with the 'L' identifier to force the type, such as 8L or 42L.
UnnecessaryOverridingMethod.description=The overriding method merely calls the same method defined in a superclass
UnnecessaryOverridingMethod.description.html=The overriding method merely calls the same method defined in a superclass
UnnecessaryCollectionCall.description=Useless call to collections. This call doesn't make sense. For any collection c, calling c.containsAll(c) should always be true, and c.retainAll(c) should have no effect.
UnnecessaryCollectionCall.description.html=Useless call to collections. This call doesn't make sense. For any collection c, calling c.containsAll(c) should always be true, and c.retainAll(c) should have no effect.
UnnecessaryCatchBlock.description=Violations are triggered when a catch block does nothing but throw the original exception. In this scenario there is usually no need for a catch block, just let the exception be thrown from the original code. This condition frequently occurs when catching an exception for debugging purposes but then forgetting to take the catch statement out.
UnnecessaryCatchBlock.description.html=Violations are triggered when a catch block does nothing but throw the original exception. In this scenario there is usually no need for a catch block, just let the exception be thrown from the original code. This condition frequently occurs when catching an exception for debugging purposes but then forgetting to take the catch statement out.
UnnecessaryCollectCall.description=Some method calls to Object.collect(Closure) can be replaced with the spread operator. For instance, list.collect { it.multiply(2) } can be replaced by list*.multiply(2). Warning: if a collection is null, collect will return an empty list, while *. will return null.
UnnecessaryCollectCall.description.html=Some method calls to Object.collect(Closure) can be replaced with the spread operator. For instance, list.collect { it.multiply(2) } can be replaced by list*.multiply(2). Warning: if a collection is null, collect will return an empty list, while *. will return null.
UnnecessaryStringInstantiation.description=Use a String literal (e.g., "...") instead of calling the corresponding String constructor (new String("..")) directly.
UnnecessaryStringInstantiation.description.html=Use a String literal (e.g., "...") instead of calling the corresponding String constructor (new String("..")) directly.
UnnecessaryElseStatement.description=When an if statement block ends with a return statement the else is unnecessary. The logic in the else branch can be run without being in a new scope.
UnnecessaryElseStatement.description.html=When an if statement block ends with a return statement the else is unnecessary. The logic in the else branch can be run without being in a new scope.
UnnecessaryParenthesesForMethodCallWithClosure.description=If a method is called and the only parameter to that method is an inline closure then the parentheses of the method call can be omitted.
UnnecessaryParenthesesForMethodCallWithClosure.description.html=If a method is called and the only parameter to that method is an inline closure then the parentheses of the method call can be omitted.
UnusedArray.description=Checks for array allocations that are not assigned or used, unless it is the last statement within a block.
UnusedArray.description.html=Checks for array allocations that are not assigned or used, unless it is the last statement within a block.
UnusedObject.description=Checks for object allocations that are not assigned or used, unless it is the last statement within a block.
UnusedObject.description.html=Checks for object allocations that are not assigned or used, unless it is the last statement within a block
UnusedPrivateField.description=Checks for private fields that are not referenced within the same class.
UnusedPrivateField.description.html=Checks for private fields that are not referenced within the same class.
UnusedPrivateMethod.description=Checks for private methods that are not referenced within the same class.
UnusedPrivateMethod.description.html=Checks for private methods that are not referenced within the same class.
UnusedPrivateMethodParameter.description=Checks for parameters to private methods that are not referenced within the method body.
UnusedPrivateMethodParameter.description.html=Checks for parameters to private methods that are not referenced within the method body.
UnusedVariable.description=Checks for variables that are never referenced. The ignoreVariableNames property (${rule.ignoreVariableNames}) specifies one or more variable names that should be ignored, optionally containing wildcard characters ('*' or '?').
UnusedVariable.description.html=Checks for variables that are never referenced. The ignoreVariableNames property (${rule.ignoreVariableNames}) specifies one or more variable names that should be ignored, optionally containing wildcard characters ('*' or '?').
WaitOutsideOfWhileLoop.description=Calls to Object.wait() must be within a while loop. Consider using the Java concurrency utilities instead of wait() and notify().
WaitOutsideOfWhileLoop.description.html=Calls to Object.wait() must be within a while loop. Consider using the Java concurrency utilities instead of wait() and notify().
SwallowThreadDeath.description=Checks for code that catches ThreadDeath without re-throwing it.
SwallowThreadDeath.description.html=Checks for code that catches ThreadDeath without re-throwing it.
StatelessSingleton.description=There is no point in creating a stateless Singleton because there is nothing within the class that needs guarding and no side effects to calling the constructor. Just create new instances of the object or write a Utility class with static methods.
StatelessSingleton.description.html=There is no point in creating a stateless Singleton because there is nothing within the class that needs guarding and no side effects to calling the constructor. Just create new instances of the object or write a Utility class with static methods.
PrivateFieldCouldBeFinal.description=Checks for private fields that are only set within a constructor or field initializer. Such fields can safely be made final.
PrivateFieldCouldBeFinal.description.html=Checks for private fields that are only set within a constructor or field initializer. Such fields can safely be made final.
ParameterReassignment.description=Checks for a method or closure parameter being reassigned to a new value within the body of the method/closure, which is a confusing and questionable practice. Use a temporary variable instead.
ParameterReassignment.description.html=Checks for a method or closure parameter being reassigned to a new value within the body of the method/closure, which is a confusing and questionable practice. Use a temporary variable instead.
TernaryCouldBeElvis.description=Checks for ternary expressions where the boolean and true expressions are the same. These can be simplified to an Elvis expression.
TernaryCouldBeElvis.description.html=Checks for ternary expressions where the boolean and true expressions are the same. These can be simplified to an Elvis expression.
AssertWithinFinallyBlock.description=Checks for assert statements within a finally block. An assert can throw an exception, hiding the original exception, if there is one.
AssertWithinFinallyBlock.description.html=Checks for assert statements within a finally block. An assert can throw an exception, hiding the original exception, if there is one.
ConstantAssertExpression.description=Checks for assert statements where the assert boolean condition expression is a constant or literal value.
ConstantAssertExpression.description.html=Checks for assert statements where the assert boolean condition expression is a constant or literal value.
BrokenNullCheck.description=Looks for faulty checks for null that can cause a NullPointerException.
BrokenNullCheck.description.html=Looks for faulty checks for null that can cause a NullPointerException.
VectorIsObsolete.description=The java.util.Vector class is effectively obsolete. Use the Java Collections Framework classes instead, including ArrayList or Collections.synchronizedList(). See the JDK javadoc.
VectorIsObsolete.description.html=The java.util.Vector class is effectively obsolete. Use the Java Collections Framework classes instead, including ArrayList or Collections.synchronizedList(). See the JDK javadoc.
HashtableIsObsolete.description=The java.util.Hashtable class is effectively obsolete. Use the Java Collections Framework classes instead, including HashMap or ConcurrentHashMap. See the JDK javadoc.
HashtableIsObsolete.description.html=The java.util.Hashtable class is effectively obsolete. Use the Java Collections Framework classes instead, including HashMap or ConcurrentHashMap. See the JDK javadoc.
CrapMetric.description=Checks the CRAP (Change Risk Anti-Patterns) score for methods/classes. \
The CRAP metric score is based on the cyclomatic complexity and test coverage for individual methods. \
A method with a CRAP value greater than the maxMethodCrapScore \
property (${rule.maxMethodCrapScore}) causes a violation. Likewise, a class that has an (average method) CRAP \
value greater than the maxClassAverageMethodCrapScore property (${rule.maxClassAverageMethodCrapScore}) causes a violation.
CrapMetric.description.html=Checks the CRAP (Change Risk Anti-Patterns) score for methods/classes. \
The CRAP metric score is based on the cyclomatic complexity and test coverage for individual methods. \
A method with a CRAP value greater than the maxMethodCrapScore \
property (${rule.maxMethodCrapScore}) causes a violation. Likewise, a class that has an (average method) CRAP \
value greater than the maxClassAverageMethodCrapScore property (${rule.maxClassAverageMethodCrapScore}) causes a violation.
JUnitLostTest.description=Checks for classes that import JUnit 4 classes and contain a public, instance, void, no-arg method named test* that is not annotated with @Test.
JUnitLostTest.description.html=Checks for classes that import JUnit 4 classes and contain a public, instance, void, no-arg method named test* that is not annotated with @Test.
SpaceAfterComma.description=Checks that there is at least one space or whitespace following each comma. That includes checks for method and closure declaration parameter lists, method call parameter lists, Map literals and List literals.
SpaceAfterComma.description.html=Checks that there is at least one space or whitespace following each comma. That includes checks for method and closure declaration parameter lists, method call parameter lists, Map literals and List literals.
SpaceAfterSemicolon.description=Checks that there is at least one space or whitespace following each semicolon separating multiple statements on a single line or the clauses within a classic for loop.
SpaceAfterSemicolon.description.html=Checks that there is at least one space or whitespace following each semicolon separating multiple statements on a single line or the clauses within a classic for loop.
SpaceAroundOperator.description=Check that there is at least one space (blank) or whitespace around each binary operator.
SpaceAroundOperator.description.html=Check that there is at least one space (blank) or whitespace around each binary operator.
SpaceBeforeOpeningBrace.description=Check that there is at least one space (blank) or whitespace before each opening brace ("{") for method/class/interface declarations, closure expressions and block statements.
SpaceBeforeOpeningBrace.description.html=Check that there is at least one space (blank) or whitespace before each opening brace ("{") for method/class/interface declarations, closure expressions and block statements.
SpaceAfterOpeningBrace.description=Check that there is at least one space (blank) or whitespace after each opening brace ("{") for method/class/interface declarations, closure expressions and block statements.
SpaceAfterOpeningBrace.description.html=Check that there is at least one space (blank) or whitespace after each opening brace ("{") for method/class/interface declarations, closure expressions and block statements.
SpaceBeforeClosingBrace.description=Check that there is at least one space (blank) or whitespace before each closing brace ("}") for method/class/interface declarations, closure expressions and block statements.
SpaceBeforeClosingBrace.description.html=Check that there is at least one space (blank) or whitespace before each closing brace ("}") for method/class/interface declarations, closure expressions and block statements.
SpaceAfterClosingBrace.description=Check that there is at least one space (blank) or whitespace after each closing brace ("}") for method/class/interface declarations, closure expressions and block statements.
SpaceAfterClosingBrace.description.html=Check that there is at least one space (blank) or whitespace after each closing brace ("}") for method/class/interface declarations, closure expressions and block statements.
SpaceAfterIf.description=Check that there is exactly one space (blank) after the if keyword and before the opening parenthesis.
SpaceAfterIf.description.html=Check that there is exactly one space (blank) after the if keyword and before the opening parenthesis.
SpaceAfterFor.description=Check that there is exactly one space (blank) after the for keyword and before the opening parenthesis.
SpaceAfterFor.description.html=Check that there is exactly one space (blank) after the for keyword and before the opening parenthesis.
SpaceAfterWhile.description=Check that there is exactly one space (blank) after the while keyword and before the opening parenthesis.
SpaceAfterWhile.description.html=Check that there is exactly one space (blank) after the while keyword and before the opening parenthesis.
SpaceAfterSwitch.description=Check that there is exactly one space (blank) after the switch keyword and before the opening parenthesis.
SpaceAfterSwitch.description.html=Check that there is exactly one space (blank) after the switch keyword and before the opening parenthesis.
SpaceAfterCatch.description=Check that there is exactly one space (blank) after the catch keyword and before the opening parenthesis.
SpaceAfterCatch.description.html=Check that there is exactly one space (blank) after the catch keyword and before the opening parenthesis.
TrailingWhitespace.description=Checks that no lines of source code end with whitespace characters.
TrailingWhitespace.description.html=Checks that no lines of source code end with whitespace characters.
JUnitUnnecessaryThrowsException.description=Check for throws clauses on JUnit test methods. That is not necessary in Groovy.
JUnitUnnecessaryThrowsException.description.html=Check for throws clauses on JUnit test methods. That is not necessary in Groovy.
GrailsDuplicateMapping.description=Check for duplicate name in a domain class mapping
GrailsDuplicateMapping.description.html=Check for duplicate name in a domain class mapping
GrailsDuplicateConstraint.description=Check for duplicate entry in domain class constraints
GrailsDuplicateConstraint.description.html=Check for duplicate entry in domain class constraints
GrailsMassAssignment.description=Untrusted input should not be allowed to set arbitrary object fields without restriction.
GrailsMassAssignment.description.html=Untrusted input should not be allowed to set arbitrary object fields without restriction.
IfStatementCouldBeTernary.description=Checks for if statements where both the if and else blocks contain only a single return statement with a constant or literal value
IfStatementCouldBeTernary.description.html=Checks for if statements where both the if and else blocks contain only a single return statement with a constant or literal value
ExceptionNotThrown.description=Checks for an exception constructor call without a throw as the last statement within a catch block.
ExceptionNotThrown.description.html=Checks for an exception constructor call without a throw as the last statement within a catch block.
NoDef.description=def should not be used. You should replace it with concrete type.
NoDef.description.html=def should not be used. You should replace it with concrete type.
#-----------------------------------------------------------------------------------------
# Report labels, etc.
#-----------------------------------------------------------------------------------------
htmlReport.titlePrefix=CodeNarc Report
htmlReport.reportTimestamp.label=Date:
htmlReport.reportTitle.title=Report title:
htmlReport.reportVersion.label=Generated with:
htmlReport.summary.title=Summary
htmlReport.summary.packageHeading=Package
htmlReport.summary.totalFilesHeading=Total Files
htmlReport.summary.filesWithViolationsHeading=Files with Violations
htmlReport.summary.priority1Heading=Priority 1
htmlReport.summary.priority2Heading=Priority 2
htmlReport.summary.priority3Heading=Priority 3
htmlReport.summary.priority4Heading=Priority 4
htmlReport.summary.allPackages=All Packages
htmlReport.violations.ruleName=Rule Name
htmlReport.violations.priority=Priority
htmlReport.violations.lineNumber=Line #
htmlReport.violations.sourceLine=Source Line / Message
htmlReport.ruleDescriptions.title=Rule Descriptions
htmlReport.ruleDescriptions.ruleNameHeading=Rule Name
htmlReport.ruleDescriptions.descriptionHeading=Description
CodeNarc-0.23/src/main/groovy/ 0000755 0001750 0001750 00000000000 12303254650 015504 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/ 0000755 0001750 0001750 00000000000 12303254650 016273 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/ 0000755 0001750 0001750 00000000000 12623571301 020051 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/ 0000755 0001750 0001750 00000000000 12623571301 021534 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/RuleSets.groovy 0000644 0001750 0001750 00000003007 12167647052 024563 0 ustar ebourg ebourg /*
* 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.ruleset
/**
* Holds list of all RuleSet files.
*
* @author Chris Mair
*/
class RuleSets {
static final ALL_RULESET_FILES = [
'rulesets/basic.xml',
'rulesets/braces.xml',
'rulesets/concurrency.xml',
'rulesets/convention.xml',
'rulesets/design.xml',
'rulesets/dry.xml',
'rulesets/enhanced.xml',
'rulesets/exceptions.xml',
'rulesets/formatting.xml',
'rulesets/generic.xml',
'rulesets/grails.xml',
'rulesets/groovyism.xml',
'rulesets/imports.xml',
'rulesets/jdbc.xml',
'rulesets/junit.xml',
'rulesets/logging.xml',
'rulesets/naming.xml',
'rulesets/security.xml',
'rulesets/serialization.xml',
'rulesets/size.xml',
'rulesets/unnecessary.xml',
'rulesets/unused.xml'
]
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/FilteredRuleSet.groovy 0000644 0001750 0001750 00000006306 12311373552 026054 0 ustar ebourg ebourg /*
* 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.ruleset
import org.codenarc.util.WildcardPattern
/**
* A RuleSet implementation that is a Decorator for another RuleSet, but provides
* the ability to filter included and excluded rules within that RuleSet.
*
* If a Rule matches both an include and an exclude, then the exclude takes precedence, i.e. the
* Rule is NOT includes in the result from getRules().
*
* @author Chris Mair
*/
class FilteredRuleSet implements RuleSet {
private final rules = []
private final includes = []
private final excludes = []
/**
* Construct a new instance on the specified RuleSet
* @param ruleset - the RuleSet to be filtered (decorated); must not be null.
*/
FilteredRuleSet(RuleSet ruleSet) {
assert ruleSet != null
rules.addAll(ruleSet.getRules())
}
/**
* Add an include criteria.
* @param include - the include specification, which is compared against the ids of all of the Rules
* within the underlying RuleSet. Only matching Rules are included in the result from getRules().
* The include value must not be null or empty.
*/
void addInclude(String include) {
assert include
includes << new WildcardPattern(include)
}
/**
* Add an exclude criteria.
* @param exclude - the exclude specification, which is compared against the ids of all of the Rules
* within the underlying RuleSet. Any matching Rules are excluded in the result from getRules().
* The exclude value must not be null or empty.
*/
void addExclude(String exclude) {
assert exclude
excludes << new WildcardPattern(exclude)
}
/**
* Return the List of Rules that match the include(s) (if specified) AND DO NOT match any exlcude(s) specified.
* @return the filtered List of Rule objects. The returned List is immutable.
*/
List getRules() {
def filteredRules = []
rules.each { rule ->
def matchesIncludes = includes.empty ||
includes.find { includePattern -> includePattern.matches(rule.name) }
if (matchesIncludes) {
def matchesExcludes = !excludes.empty &&
excludes.find { excludePattern -> excludePattern.matches(rule.name) }
if (!matchesExcludes) {
filteredRules << rule
}
}
}
filteredRules.asImmutable()
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/RuleSet.groovy 0000644 0001750 0001750 00000001636 12311373552 024376 0 ustar ebourg ebourg /*
* Copyright 2008 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.ruleset
/**
* Represents a set of (configured) Rule objects that can be applied for static analysis.
*
* @author Chris Mair
*/
interface RuleSet {
/**
* @return a List of optionally configured Rule objects
*/
List getRules()
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/XmlFileRuleSet.groovy 0000644 0001750 0001750 00000004606 12311373552 025657 0 ustar ebourg ebourg /*
* Copyright 2008 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.ruleset
import org.apache.log4j.Logger
import org.codenarc.util.io.DefaultResourceFactory
import org.codenarc.util.io.ResourceFactory
/**
* A RuleSet implementation that parses Rule definitions from XML read from a
* file. The filename passed into the constructor is interpreted relative to the classpath, by
* default, but may be optionally prefixed by any of the valid java.net.URL prefixes, such as
* "file:" (to load from a relative or absolute path on the filesystem), or "http:".
*
* Note that this class attempts to read the file and parse the XML from within the constructor.
*
* @author Chris Mair
*/
class XmlFileRuleSet implements RuleSet {
private static final LOG = Logger.getLogger(XmlFileRuleSet)
private final ResourceFactory resourceFactory = new DefaultResourceFactory()
private List rules = []
/**
* Construct a new instance on the specified RuleSet file path
* @param path - the path to the XML RuleSet definition file. The path is relative to the classpath,
* by default, but may be optionally prefixed by any of the valid java.net.URL prefixes, such
* as "file:" (to load from a relative or absolute path on the filesystem), or "http:". The
* path must not be empty or null.
*/
XmlFileRuleSet(String path) {
assert path
LOG.info("Loading ruleset from [$path]")
def inputStream = resourceFactory.getResource(path).inputStream
inputStream.withReader { reader ->
def xmlReaderRuleSet = new XmlReaderRuleSet(reader)
this.rules = xmlReaderRuleSet.rules
}
}
/**
* @return a List of Rule objects
*/
List getRules() {
rules
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/RuleSetUtil.groovy 0000644 0001750 0001750 00000004516 12403436520 025231 0 ustar ebourg ebourg /*
* 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.ruleset
import org.codenarc.rule.Rule
import org.codenarc.util.io.DefaultResourceFactory
import org.codenarc.util.io.ResourceFactory
/**
* A private utility class for the RuleSet classes. All methods are static.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class RuleSetUtil {
protected static final String CLASS_LOADER_SYS_PROP = 'codenarc.useCurrentThreadContextClassLoader'
private static final ResourceFactory RESOURCE_FACTORY = new DefaultResourceFactory()
protected static void assertClassImplementsRuleInterface(Class ruleClass) {
assert ruleClass
assert Rule.isAssignableFrom(ruleClass), "The rule class [${ruleClass.name}] does not implement the Rule interface"
}
static RuleSet loadRuleSetFile(String path) {
isXmlFile(path) ? new XmlFileRuleSet(path) : new GroovyDslRuleSet(path)
}
protected static Rule loadRuleScriptFile(String path) {
def inputStream = RESOURCE_FACTORY.getResource(path).inputStream
Class ruleClass
inputStream.withStream { input ->
ClassLoader parentClassLoader = (System.getProperty(CLASS_LOADER_SYS_PROP) == 'true') ?
Thread.currentThread().getContextClassLoader() :
getClass().classLoader
GroovyClassLoader gcl = new GroovyClassLoader(parentClassLoader)
ruleClass = gcl.parseClass(input.text)
}
assertClassImplementsRuleInterface(ruleClass)
ruleClass.newInstance()
}
private static boolean isXmlFile(String path) {
path && path.endsWith('.xml')
}
private RuleSetUtil() { }
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/CompositeRuleSet.groovy 0000644 0001750 0001750 00000002771 12311373552 026262 0 ustar ebourg ebourg /*
* 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.ruleset
import org.codenarc.rule.Rule
/**
* A RuleSet implementation that aggregates a set of RuleSets and Rules.
*
* @author Chris Mair
*/
class CompositeRuleSet implements RuleSet {
private final rules = []
/**
* Add a single Rule to this RuleSet
* @param rule - the Rule to add
*/
void addRule(Rule rule) {
assert rule != null
rules << rule
}
/**
* Add all of the Rules within the specified RuleSet to this RuleSet
* @param ruleSet - the RuleSet whose Rules are to be included
*/
void addRuleSet(RuleSet ruleSet) {
assert ruleSet != null
rules.addAll(ruleSet.getRules())
}
/**
* @return a List of Rule objects. The returned List is immutable.
*/
List getRules() {
rules.asImmutable()
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/MovedRules.groovy 0000644 0001750 0001750 00000012722 12006632016 025070 0 ustar ebourg ebourg /*
* Copyright 2011 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.ruleset
/**
* Helper class to manage information for moved or renamed rules, and provide helpful error message.
*
* @author Chris Mair
*/
class MovedRules {
private static final CONVENTION_RULESET = 'rulesets/convention.xml'
private static final DESIGN_RULESET = 'rulesets/design.xml'
private static final UNNECESSARY_RULESET = 'rulesets/unnecessary.xml'
private static final GROOVYISM_RULESET = 'rulesets/groovyism.xml'
private static final SERIALIZATION_RULESET = 'rulesets/serialization.xml'
private static class MovedToRuleSet {
String ruleSetName
String messageFor(String name) {
"The \"$name\" rule has been moved to the \"$ruleSetName\" ruleset."
}
}
private static class Renamed {
String newRuleName
String messageFor(String name) {
"The \"$name\" rule has been renamed to \"$newRuleName\"."
}
}
private static final RULES = [
HardcodedWindowsRootDirectory: renamedTo('HardCodedWindowsRootDirectory'),
AddEmptyString: movedTo(UNNECESSARY_RULESET),
AssignCollectionSort: movedTo(GROOVYISM_RULESET),
AssignCollectionUnique: movedTo(GROOVYISM_RULESET),
BooleanMethodReturnsNull: movedTo(DESIGN_RULESET),
CloneableWithoutClone: movedTo(DESIGN_RULESET),
ClosureAsLastMethodParameter: movedTo(GROOVYISM_RULESET),
CollectAllIsDeprecated: movedTo(GROOVYISM_RULESET),
CompareToWithoutComparable: movedTo(DESIGN_RULESET),
ConfusingMultipleReturns: movedTo(GROOVYISM_RULESET),
ConfusingTernary: movedTo(CONVENTION_RULESET),
ConsecutiveLiteralAppends: movedTo(UNNECESSARY_RULESET),
ConsecutiveStringConcatenation: movedTo(UNNECESSARY_RULESET),
CouldBeElvis: movedTo(CONVENTION_RULESET),
ExplicitArrayListInstantiation: movedTo(GROOVYISM_RULESET),
ExplicitCallToAndMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToCompareToMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToDivMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToEqualsMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToGetAtMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToLeftShiftMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToMinusMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToModMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToMultiplyMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToOrMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToPlusMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToPowerMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToRightShiftMethod: movedTo(GROOVYISM_RULESET),
ExplicitCallToXorMethod: movedTo(GROOVYISM_RULESET),
ExplicitHashMapInstantiation: movedTo(GROOVYISM_RULESET),
ExplicitHashSetInstantiation: movedTo(GROOVYISM_RULESET),
ExplicitLinkedHashMapInstantiation: movedTo(GROOVYISM_RULESET),
ExplicitLinkedListInstantiation: movedTo(GROOVYISM_RULESET),
ExplicitStackInstantiation: movedTo(GROOVYISM_RULESET),
ExplicitTreeSetInstantiation: movedTo(GROOVYISM_RULESET),
GStringAsMapKey: movedTo(GROOVYISM_RULESET),
GroovyLangImmutable: movedTo(GROOVYISM_RULESET),
InvertedIfElse: movedTo(CONVENTION_RULESET),
LongLiteralWithLowerCaseL: movedTo(CONVENTION_RULESET),
ReturnsNullInsteadOfEmptyArray: movedTo(DESIGN_RULESET),
ReturnsNullInsteadOfEmptyCollection: movedTo(DESIGN_RULESET),
SimpleDateFormatMissingLocale: movedTo(DESIGN_RULESET),
UseCollectMany: movedTo(GROOVYISM_RULESET),
UseCollectNested: movedTo(GROOVYISM_RULESET),
SerialVersionUID: movedTo(SERIALIZATION_RULESET), // 0.14
SerializableClassMustDefineSerialVersionUID: movedTo(SERIALIZATION_RULESET), // 0.14
StringInstantiation: movedTo(UNNECESSARY_RULESET), // 0.12
BooleanInstantiation: movedTo(UNNECESSARY_RULESET), // 0.12
UnnecessaryBooleanExpression: movedTo(UNNECESSARY_RULESET), // 0.11
UnnecessaryIfStatement: movedTo(UNNECESSARY_RULESET), // 0.11
UnnecessaryTernaryExpression: movedTo(UNNECESSARY_RULESET) // 0.11
]
static String getMovedOrRenamedMessageForRuleName(String name) {
def message = RULES[name]?.messageFor(name)
return message ?: ''
}
private static Renamed renamedTo(String newRuleName) {
return new Renamed(newRuleName:newRuleName)
}
private static MovedToRuleSet movedTo(String ruleSetName) {
return new MovedToRuleSet(ruleSetName:ruleSetName)
}
// Private constructor to prevent instantiation. All methods are static.
private MovedRules() { }
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/RuleSetBuilder.groovy 0000644 0001750 0001750 00000012221 12311373552 025675 0 ustar ebourg ebourg /*
* 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.ruleset
import org.codenarc.rule.Rule
import org.codenarc.ruleregistry.RuleRegistryHolder
/**
* A Builder for RuleSets. Create a RuleSet by calling the ruleset
* method, passing in a Closure defining the contents of the RuleSet.
* The Closure can contain any combination of the following (as well as
* arbitrary Groovy code):
*
*
ruleset - to load a RuleSet file. The path specifies either a
* Groovy file or an XML file.
*
rule - to load a single Rule (specify either the rule name or rule class)
*
description - description of the RuleSet (optional)
*
*
* @author Chris Mair
*/
class RuleSetBuilder {
private final topLevelDelegate = new TopLevelDelegate()
void ruleset(Closure closure) {
closure.delegate = topLevelDelegate
closure.call()
}
RuleSet getRuleSet() {
topLevelDelegate.ruleSet
}
}
class TopLevelDelegate {
private final allRuleSet = new CompositeRuleSet()
void ruleset(String path) {
def ruleSet = RuleSetUtil.loadRuleSetFile(path)
allRuleSet.addRuleSet(ruleSet)
}
void ruleset(String path, Closure closure) {
def ruleSet = RuleSetUtil.loadRuleSetFile(path)
def ruleSetConfigurer = new RuleSetDelegate(ruleSet)
closure.delegate = ruleSetConfigurer
closure.setResolveStrategy(Closure.DELEGATE_FIRST)
closure.call()
allRuleSet.addRuleSet(ruleSetConfigurer.ruleSet)
}
void rule(Class ruleClass) {
RuleSetUtil.assertClassImplementsRuleInterface(ruleClass)
Rule rule = ruleClass.newInstance()
allRuleSet.addRule(rule)
}
void rule(Class ruleClass, Map properties) {
RuleSetUtil.assertClassImplementsRuleInterface(ruleClass) // TODO refactor
Rule rule = ruleClass.newInstance()
properties.each { key, value -> rule[key] = value }
allRuleSet.addRule(rule)
}
void rule(Class ruleClass, Closure closure) {
RuleSetUtil.assertClassImplementsRuleInterface(ruleClass)
Rule rule = ruleClass.newInstance()
closure.delegate = rule
closure.resolveStrategy = Closure.DELEGATE_FIRST
closure.call()
allRuleSet.addRule(rule)
}
void rule(String path) {
def rule = RuleSetUtil.loadRuleScriptFile(path)
allRuleSet.addRule(rule)
}
void rule(String path, Closure closure) {
def rule = RuleSetUtil.loadRuleScriptFile(path)
closure.delegate = rule
closure.resolveStrategy = Closure.DELEGATE_FIRST
closure.call()
allRuleSet.addRule(rule)
}
def propertyMissing(String name) {
def ruleClass = RuleRegistryHolder.ruleRegistry?.getRuleClass(name)
assert ruleClass, "No such rule named [$name]. " + MovedRules.getMovedOrRenamedMessageForRuleName(name)
rule(ruleClass)
}
def methodMissing(String name, args) {
def ruleClass = RuleRegistryHolder.ruleRegistry?.getRuleClass(name)
assert ruleClass, "No such rule named [$name]. " + MovedRules.getMovedOrRenamedMessageForRuleName(name)
if (args.size() > 0) {
rule(ruleClass, args[0])
}
else {
rule(ruleClass)
}
}
@SuppressWarnings(['EmptyMethod', 'UnusedMethodParameter'])
void description(String description) {
// Do nothing
}
protected RuleSet getRuleSet() {
allRuleSet
}
}
class RuleSetDelegate {
RuleSet ruleSet
RuleSetDelegate(RuleSet ruleSet) {
this.ruleSet = new FilteredRuleSet(ruleSet)
}
void exclude(String excludeNames) {
ruleSet.addExclude(excludeNames)
}
void include(String includeNames) {
ruleSet.addInclude(includeNames)
}
def methodMissing(String name, args) {
def rule = findRule(name)
assert rule, "No such rule named [$name]. " + MovedRules.getMovedOrRenamedMessageForRuleName(name)
def arg = args[0]
if (arg instanceof Closure) {
arg.delegate = rule
arg.setResolveStrategy(Closure.DELEGATE_FIRST)
arg.call()
}
else {
// Assume it is a Map
arg.each { key, value -> rule[key] = value }
}
}
private Rule findRule(String name) {
ruleSet.rules.find { rule -> rule.name == name }
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/GroovyDslRuleSet.groovy 0000644 0001750 0001750 00000005774 12403114530 026245 0 ustar ebourg ebourg /*
* 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.ruleset
import org.apache.log4j.Logger
import org.codehaus.groovy.control.MultipleCompilationErrorsException
import org.codenarc.util.io.DefaultResourceFactory
import org.codenarc.util.io.ResourceFactory
/**
* A RuleSet implementation that parses a Groovy DSL of RuleSet definitions.
* The filename passed into the constructor is interpreted relative to the classpath.
* Note that this class attempts to read the file and parse the Groovy from within the constructor.
*
* @author Chris Mair
*/
class GroovyDslRuleSet implements RuleSet {
private static final LOG = Logger.getLogger(GroovyDslRuleSet)
private final ResourceFactory resourceFactory = new DefaultResourceFactory()
private final RuleSetBuilder ruleSetBuilder = new RuleSetBuilder()
private final String path
private final rules
/**
* Construct a new instance on the specified Groovy DSL RuleSet file path
* @param path - the path to the Groovy DSL RuleSet definition file, relative to the classpath; must not be empty or null
*/
GroovyDslRuleSet(String path) {
assert path
this.path = path
LOG.info("Loading ruleset from [$path]")
GroovyShell shell = createGroovyShell()
evaluateDsl(shell)
rules = ruleSetBuilder.ruleSet.rules
}
private GroovyShell createGroovyShell() {
def callRuleSet = { Closure closure ->
closure.resolveStrategy = Closure.DELEGATE_ONLY // fail if access non-existent properties
ruleSetBuilder.ruleset(closure)
}
Binding binding = new Binding(ruleset:callRuleSet)
return new GroovyShell(this.class.classLoader, binding)
}
private void evaluateDsl(GroovyShell shell) {
def inputStream = resourceFactory.getResource(path).inputStream
inputStream.withReader { reader ->
try {
shell.evaluate(reader)
} catch (MultipleCompilationErrorsException compileError) {
LOG.error("An error occurred compiling the configuration file $path", compileError)
throw new IllegalStateException("An error occurred compiling the configuration file $path\n${compileError.message}")
}
}
}
/**
* @return a List of Rule objects
*/
List getRules() {
rules
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/XmlReaderRuleSet.groovy 0000644 0001750 0001750 00000012432 12311373552 026176 0 ustar ebourg ebourg /*
* 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.ruleset
import groovy.xml.Namespace
import org.codenarc.util.PropertyUtil
import org.codenarc.util.io.ClassPathResource
import javax.xml.transform.stream.StreamSource
import javax.xml.validation.SchemaFactory
/**
* A RuleSet implementation that parses Rule definitions from XML read from a
* Reader. Note that this class attempts to read and parse the XML from within
* the constructor.
*
* @author Chris Mair
*/
@SuppressWarnings('DuplicateLiteral')
class XmlReaderRuleSet implements RuleSet {
// W3C_XML_SCHEMA_NS_URI constant is not defined in older versions of javax.xml.XMLConstants
private static final XML_SCHEMA_URI = 'http://www.w3.org/2001/XMLSchema'
private static final NS = new Namespace('http://codenarc.org/ruleset/1.0')
private static final RULESET_SCHEMA_FILE = 'ruleset-schema.xsd'
private final List rules = []
/**
* Construct a new instance on the specified Reader
* @param reader - the Reader from which the XML will be read; must not be null
*/
XmlReaderRuleSet(Reader reader) {
assert reader
def xml = reader.text
validateXml(xml)
def ruleset = new XmlParser().parseText(xml)
loadRuleSetRefElements(ruleset)
loadRuleElements(ruleset)
loadRuleScriptElements(ruleset)
rules = rules.asImmutable()
}
/**
* @return a List of Rule objects
*/
List getRules() {
rules
}
//--------------------------------------------------------------------------
// Internal Helper Methods
//--------------------------------------------------------------------------
private void loadRuleSetRefElements(ruleset) {
ruleset[NS.'ruleset-ref'].each { ruleSetRefNode ->
def ruleSetPath = ruleSetRefNode.attribute('path')
def refRuleSet = RuleSetUtil.loadRuleSetFile(ruleSetPath)
def allRules = refRuleSet.rules
def filteredRuleSet = new FilteredRuleSet(refRuleSet)
ruleSetRefNode[NS.'include'].each { includeNode ->
def includeRuleName = includeNode.attribute('name')
filteredRuleSet.addInclude(includeRuleName)
}
ruleSetRefNode[NS.'exclude'].each { excludeNode ->
def excludeRuleName = excludeNode.attribute('name')
filteredRuleSet.addExclude(excludeRuleName)
}
ruleSetRefNode[NS.'rule-config'].each { configNode ->
def configRuleName = configNode.attribute('name')
def rule = allRules.find { it.name == configRuleName }
assert rule, "Rule named [$configRuleName] referenced within was not found. " +
MovedRules.getMovedOrRenamedMessageForRuleName(configRuleName)
configNode[NS.property].each { p ->
def name = p.attribute('name')
def value = p.attribute('value')
PropertyUtil.setPropertyFromString(rule, name, value)
}
}
rules.addAll(filteredRuleSet.rules)
}
}
private void loadRuleElements(ruleset) {
ruleset[NS.rule].each { ruleNode ->
def ruleClassName = ruleNode.attribute('class')
def ruleClass = getClass().classLoader.loadClass(ruleClassName.toString())
RuleSetUtil.assertClassImplementsRuleInterface(ruleClass)
def rule = ruleClass.newInstance()
rules << rule
setRuleProperties(ruleNode, rule)
}
}
private void loadRuleScriptElements(ruleset) {
ruleset[NS.'rule-script'].each { ruleScriptNode ->
def ruleScriptPath = ruleScriptNode.attribute('path')
def rule = RuleSetUtil.loadRuleScriptFile(ruleScriptPath)
rules << rule
setRuleProperties(ruleScriptNode, rule)
}
}
private setRuleProperties(ruleNode, rule) {
ruleNode[NS.property].each { p ->
def name = p.attribute('name')
def value = p.attribute('value')
PropertyUtil.setPropertyFromString(rule, name, value)
}
}
private void validateXml(String xml) {
def factory = SchemaFactory.newInstance(XML_SCHEMA_URI)
def schema = factory.newSchema(new StreamSource(getSchemaXmlInputStream()))
def validator = schema.newValidator()
validator.validate(new StreamSource(new StringReader(xml)))
}
private InputStream getSchemaXmlInputStream() {
ClassPathResource.getInputStream(RULESET_SCHEMA_FILE)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/PropertiesFileRuleSetConfigurer.groovy 0000644 0001750 0001750 00000010372 12311373552 031274 0 ustar ebourg ebourg /*
* 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.ruleset
import org.apache.log4j.Logger
import org.codenarc.util.PropertyUtil
import org.codenarc.util.io.DefaultResourceFactory
import org.codenarc.util.io.ResourceFactory
/**
* Reads the properties file named "codenarc.properties", if found on the classpath, and applies
* the property values to matching Rules within a specified RuleSet. If the
* properties file is not found on the classpath, then do nothing.
*
* The default name of the properties file ("codenarc.properties") can be overridden by setting
* the "codenarc.properties.file" system property to the new filename. Note that the new filename
* is still relative to the classpath, and may optionally contain (relative) path components (e.g.
* "src/resources/my-codenarc.properties").
*
* For each properties entry of the form [rule-name].[property-name]=[property-value],
* the named property for the rule within the RuleSet matching rule-name is set to the
* specified property-value. Properties entries not of this form or specifying rule
* names not within the specified RuleSet are ignored.
*
* @author Chris Mair
*/
class PropertiesFileRuleSetConfigurer {
private static final LOG = Logger.getLogger(PropertiesFileRuleSetConfigurer)
private static final PROPERTIES_FILE_SYSPROP = 'codenarc.properties.file'
private final ResourceFactory resourceFactory = new DefaultResourceFactory()
protected defaultPropertiesFilename = 'codenarc.properties'
/**
* Configure the rules within the RuleSet from the properties file (relative to the classpath).
* The default properties filename is "codenarc.properties", but can be overridden by setting the
* "codenarc.properties.filename" system property.
*
* Each properties entry of the form [rule-name].[property-name]=[property-value]
* is used to set the named property of the named rule. Other (non-matching)
* property entries are ignored.
* @param ruleSet - the RuleSet to configure; must not be null
*/
void configure(RuleSet ruleSet) {
assert ruleSet
def propertiesFilename = System.getProperty(PROPERTIES_FILE_SYSPROP) ?: defaultPropertiesFilename
try {
def inputStream = resourceFactory.getResource(propertiesFilename).inputStream
LOG.info("Reading RuleSet configuration from properties file [$propertiesFilename].")
inputStream.withStream { input ->
def properties = new Properties()
properties.load(input)
applyProperties(properties, ruleSet)
}
}
catch(IOException e) {
LOG.info("RuleSet configuration properties file [$propertiesFilename] not found.")
}
}
private applyProperties(Properties properties, RuleSet ruleSet) {
final PATTERN = ~/(\w*)\.(\w*)/
properties.each { k, v ->
def matcher = PATTERN.matcher(k)
if (matcher.matches()) {
def ruleName = matcher[0][1]
def propertyName = matcher[0][2]
def rule = findRule(ruleSet, ruleName)
if (rule) {
PropertyUtil.setPropertyFromString(rule, propertyName, v)
}
else {
LOG.warn("No such rule [$ruleName] for property [$k]. " + MovedRules.getMovedOrRenamedMessageForRuleName(ruleName))
}
}
}
}
private findRule(RuleSet ruleSet, String name) {
ruleSet.rules.find { rule -> rule.name == name }
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleset/ListRuleSet.groovy 0000644 0001750 0001750 00000002635 12311373552 025232 0 ustar ebourg ebourg /*
* Copyright 2008 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.ruleset
import org.codenarc.rule.Rule
/**
* A RuleSet implementation that returns a static List of Rules passed into its constructor.
*
* @author Chris Mair
*/
class ListRuleSet implements RuleSet {
private final rules
/**
* Construct a new instance from the specified List of rules.
* @param rules - the List of List of Rule objects; must not be null, but may be empty.
*/
ListRuleSet(List rules) {
assert rules != null
assert rules.every { it instanceof Rule }
def copy = []
copy.addAll(rules)
this.rules = Collections.unmodifiableList(copy)
}
/**
* @return a List of Rule objects
*/
List getRules() {
rules
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/ 0000755 0001750 0001750 00000000000 12623571301 021026 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/util/PathUtil.groovy 0000644 0001750 0001750 00000004157 12311373553 024041 0 ustar ebourg ebourg /*
* 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.util
/**
* Path-related utility methods.
*
* @author Chris Mair
*/
class PathUtil {
private static final SEP = '/'
static String getName(String path) {
if (!path) {
return null
}
int separatorIndex1 = path.lastIndexOf('/')
int separatorIndex2 = path.lastIndexOf('\\')
int separatorIndex = [separatorIndex1, separatorIndex2].max()
(separatorIndex == -1) ? path : path[separatorIndex + 1 .. -1]
}
static String getParentPath(String filePath) {
def normalizedPath = normalizePath(filePath)
def partList = normalizedPath ? normalizedPath.tokenize(SEP) : []
if (partList.size() < 2) {
return null
}
def parentList = partList[0..-2]
parentList.join(SEP)
}
static String normalizePath(String path) {
path ? path.replaceAll('\\\\', SEP) : path
}
static String removePathPrefix(String prefix, String path) {
def resultPath = path
if (prefix && resultPath.startsWith(prefix)) {
resultPath = resultPath - prefix
return removeLeadingSlash(resultPath)
}
resultPath
}
private static String removeLeadingSlash(path) {
(path.startsWith('\\') || path.startsWith(SEP)) ? path[1 .. -1] : path
}
// Private constructor to prevent instantiation. All members are static.
private PathUtil() { }
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/GroovyVersion.groovy 0000644 0001750 0001750 00000002755 12006632016 025135 0 ustar ebourg ebourg /*
* 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.util
/**
* Utility methods to determine the version of Groovy currently executing.
*
* @author Chris Mair
*/
class GroovyVersion {
static String getVersion() {
try {
return GroovySystem.getVersion()
}
catch(MissingMethodException e) {
return new org.codehaus.groovy.runtime.InvokerHelper().version
}
}
static boolean isGroovy1_8() {
getVersion().startsWith('1.8')
}
static boolean isGroovy2_x() {
getVersion().startsWith('2.')
}
static boolean isGroovy1_8_OrGreater() {
isGroovy1_8() || isGroovy2_x()
}
static boolean isGroovy1_7() {
getVersion().startsWith('1.7')
}
static boolean isGroovy1_6() {
getVersion().startsWith('1.6')
}
private GroovyVersion() { }
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/ConsecutiveUtils.groovy 0000644 0001750 0001750 00000002630 12006632016 025602 0 ustar ebourg ebourg /*
* 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.util
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.GStringExpression
/**
*
* Utility class for Consecutive* rules.
*
* @author Hamlet D'Arcy
*/
class ConsecutiveUtils {
static boolean areJoinableConstants(Expression left, Expression right) {
if (left.lastLineNumber != right.lineNumber) {
return false
}
if (isJoinableType(left) && isJoinableType(right)) {
return true
}
false
}
static boolean isJoinableType(Expression expression) {
if (expression instanceof ConstantExpression && !AstUtil.isNull(expression)) {
return true
}
return expression instanceof GStringExpression
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/SourceCodeUtil.groovy 0000644 0001750 0001750 00000005551 12006632016 025170 0 ustar ebourg ebourg /*
* Copyright 2008 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.util
import org.codehaus.groovy.ast.ASTNode
import org.codenarc.source.SourceCode
/**
* Contains source related static utility methods
*
* @author Marcin Erdmann
*/
class SourceCodeUtil {
static List nodeSourceLines(SourceCode source, ASTNode node) {
sourceLinesBetween(source, node.lineNumber, node.columnNumber, node.lastLineNumber, node.lastColumnNumber)
}
static List sourceLinesBetweenNodes(SourceCode source, ASTNode startNode, ASTNode endNode) {
sourceLinesBetween(source, startNode.lastLineNumber, startNode.lastColumnNumber, endNode.lineNumber, endNode.columnNumber)
}
/**
* Retrieves source lines between the start line and column and end line and column. Lines and columns are counted
* starting at one as do the lines and columns describing a beginning and end of ASTNode.
*
* @param source Source from which the lines are to be extracted
* @param startLine has to be greater than zero
* @param startColumn has to be greater than zero
* @param endLine has to be greater than zero
* @param endColumn has to be greater than zero
* @return a List of string containing the extracted code
* @throws IllegalArgumentException when start is not before end, and any of the start/end parameters is lower than one
*/
static List sourceLinesBetween(SourceCode source, int startLine, int startColumn, int endLine, int endColumn) {
if (startLine < 1 || startColumn < 1 || endLine < 1 || endColumn < 1) {
throw new IllegalArgumentException('Start and end indexes are one based and have to be greater than zero')
}
if (endLine < startLine || (endLine == startLine && endColumn < startColumn)) {
throw new IllegalArgumentException('End line/column has to be after start line/column')
}
def nodeLines = source.lines[(startLine - 1)..(endLine - 1)] as ArrayList
if (nodeLines.size() > 1) {
nodeLines[0] = startColumn - 1 == nodeLines.first().size() ? '' : nodeLines.first()[(startColumn - 1)..-1]
nodeLines[-1] = nodeLines.last()[0..(endColumn - 2)]
return nodeLines
}
return [nodeLines.first()[(startColumn - 1)..(endColumn - 2)]]
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/PropertyUtil.groovy 0000644 0001750 0001750 00000004335 12403443524 024765 0 ustar ebourg ebourg /*
* Copyright 2008 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.util
/**
* Contains property-related static utility methods
*
* @author Chris Mair
*/
class PropertyUtil {
/**
* Set the value of the named property on the specified Object from a String value.
* If the name specifies an int, long or boolean value then trim and parse the provided String value
* and convert to the appropriate type.
* @param object - the Object whose field should be set
* @param name - the property name to set
* @param value - the property value as a String
* @throws NoSuchFieldException - if the object does not contain the named field
*/
static void setPropertyFromString(Object object, String propertyName, String propertyValue) {
def property = object.metaClass.getMetaProperty(propertyName)
if (property == null) {
throw new NoSuchFieldException(propertyName)
}
Object newPropertyValue = propertyValue
if (property.type == int) {
newPropertyValue = Integer.parseInt(propertyValue.trim())
}
if (property.type == long) {
newPropertyValue = Long.parseLong(propertyValue.trim())
}
if (property.type == boolean) {
newPropertyValue = Boolean.parseBoolean(propertyValue.trim())
}
if (property.type == BigDecimal) {
newPropertyValue = new BigDecimal(propertyValue.trim())
}
object[propertyName] = newPropertyValue
}
/**
* Private constructor. All methods are static.
*/
private PropertyUtil() { }
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/ImportUtil.groovy 0000644 0001750 0001750 00000014253 12237722336 024421 0 ustar ebourg ebourg /*
* Copyright 2011 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.util
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.ImportNode
import org.codenarc.source.SourceCode
/**
* Contains static utility methods and constants related to Import statements.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class ImportUtil {
/**
* Return the package name for the specified import statement or else an empty String
* @param importNode - the ImportNode for the import
* @return the name package being imported (i.e., the import minus the class name/spec)
* or an empty String if the import contains no package component
*/
static String packageNameForImport(ImportNode importNode) {
if (importNode.className) {
def importClassName = importNode.className
def index = importClassName.lastIndexOf('.')
(index == -1) ? '' : importClassName[0..index - 1]
}
else {
def packageName = importNode.packageName
packageName.endsWith('.') ? packageName[0..-2] : packageName
}
}
/**
* Return the source line and line number for the specified import class name and alias
* @param sourceCode - the SourceCode being processed
* @param importNode - the ImportNode representing the import
* @return an object that has 'sourceLine' and 'lineNumber' fields
*/
static Map sourceLineAndNumberForImport(SourceCode sourceCode, String className, String alias) {
// NOTE: This won't properly handle the case of multiple imports for same class if not all are aliased
def index = sourceCode.lines.findIndexOf { line ->
if (!line.contains('import')) { return false }
if (!line.contains(alias)) { return false }
def classNameIndex = line.indexOf(className)
if (classNameIndex == -1) { return false }
def afterIndex = classNameIndex + className.size()
if (afterIndex >= line.size()) { return true } // the className is the last thing on the line
if (line[afterIndex..-1].startsWith('.' + alias)) { return true } // className.
return line[afterIndex] =~ /[\/\s\;]/
}
def lineNumber = index == -1 ? null : index + 1
def sourceLine = lineNumber == null ? "import $className as $alias".toString() : sourceCode.lines[lineNumber - 1].trim()
[sourceLine: sourceLine, lineNumber: lineNumber]
}
/**
* Return the source line and line number for the specified import class name and alias
* @param sourceCode - the SourceCode being processed
* @param importNode - the ImportNode representing the import
* @return an object that has 'sourceLine' and 'lineNumber' fields
*/
static Map sourceLineAndNumberForStarImport(SourceCode sourceCode, ImportNode importNode) {
if (!importNode.isStar()) {
return [sourceLine: -1, lineNumber: -1]
}
// NOTE: This won't properly handle the case of multiple imports for same class if not all are aliased
def index = sourceCode.lines.findIndexOf { line ->
line.contains('import') &&
(line.contains(importNode.packageName + '*') || (importNode.className && line.contains(importNode.className)))
}
def lineNumber = index == -1 ? null : index + 1
def sourceLine = lineNumber == null ? "import ${importNode.packageName}*".toString() : sourceCode.lines[lineNumber - 1].trim()
[sourceLine: sourceLine, lineNumber: lineNumber]
}
static Map sourceLineAndNumberForNonStarImport(SourceCode sourceCode, ImportNode importNode) {
ClassNode importClassNode = importNode.type
if (importClassNode && importClassNode.lineNumber && importClassNode.lineNumber != -1) {
int lineNumber = importClassNode.lineNumber
String sourceLine = sourceCode.line(lineNumber - 1) ?: importNode.text
return [sourceLine: sourceLine, lineNumber: lineNumber]
}
return sourceLineAndNumberForImport(sourceCode, importNode.className, importNode.alias)
}
/**
* Return the source line and line number for the specified import
* @param sourceCode - the SourceCode being processed
* @param importNode - the ImportNode representing the import
* @return an object that has 'sourceLine' and 'lineNumber' fields
*/
static Map sourceLineAndNumberForImport(SourceCode sourceCode, ImportNode importNode) {
if (importNode.isStar()) {
sourceLineAndNumberForStarImport(sourceCode, importNode)
} else {
sourceLineAndNumberForNonStarImport(sourceCode, importNode)
}
}
static List getImportsSortedByLineNumber(sourceCode) {
def staticImports = sourceCode.ast.staticImports.values() + sourceCode.ast.staticStarImports.values()
def allImports = sourceCode.ast.imports + sourceCode.ast.starImports + staticImports
return sortImportsByLineNumber(allImports, sourceCode)
}
static List getNonStaticImportsSortedByLineNumber(sourceCode) {
def allImports = sourceCode.ast.imports + sourceCode.ast.starImports
return sortImportsByLineNumber(allImports, sourceCode)
}
private static List sortImportsByLineNumber(List imports, sourceCode) {
imports.sort { importNode ->
def importInfo = ImportUtil.sourceLineAndNumberForImport(sourceCode, importNode)
importInfo.lineNumber
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/io/ 0000755 0001750 0001750 00000000000 12623571301 021435 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/util/io/UrlResource.groovy 0000644 0001750 0001750 00000003477 12311373552 025173 0 ustar ebourg ebourg /*
* Copyright 2012 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.util.io
/**
* A Resource implementation based on java.net.URL.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class UrlResource implements Resource {
final String path
/**
* Construct a new FileResource
* @param path - the filesystem path to the file. May be absolute or relative.
*/
UrlResource(String path) {
assert path
this.path = path
}
/**
* Open a FileInputStream on the file
* @throws IOException - if an error occurs opening the InputStream
*/
InputStream getInputStream() throws IOException {
def url = new URL(path)
url.openStream()
}
/**
* @return true only if this resource exists and is accessible
*/
boolean exists() {
def inputStream
try {
def url = new URL(path)
inputStream = url.openStream()
return inputStream != null
}
catch (IOException e) {
return false
}
finally {
if (inputStream) {
inputStream.close()
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/io/Resource.groovy 0000644 0001750 0001750 00000002521 12311373552 024475 0 ustar ebourg ebourg /*
* Copyright 2012 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.util.io
/**
* Defines the interface for objects that represent a resource (e.g. a file) and
* provide access to its InputStream.
*
* The design of this (resource) framework is heavily influenced by the Resource classes
* within The Spring Framework.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
interface Resource {
/**
* Return the InputStream for this resource.
* @throws IOException - if an error occurs opening the InputStream
*/
InputStream getInputStream() throws IOException
/**
* @return true only if this resource exists and is accessible
*/
boolean exists()
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/io/ClassPathResource.groovy 0000644 0001750 0001750 00000006062 12311373552 026304 0 ustar ebourg ebourg /*
* Copyright 2012 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.util.io
/**
* A Resource implementation for resources available on the classpath.
*
* This class also provides a static InputStream getInputStream(String path) convenience method.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class ClassPathResource implements Resource {
final String path
/**
* Convenience method to open an InputStream on the specified resource path relative the classpath
* @path - the path to the resource (file). The path is relative to the classpath,
* by default, but may be optionally prefixed by any of the valid java.net.URL prefixes, such
* as "file:" (to load from a relative or absolute path on the filesystem), or "http:". The
* path must not be empty or null.
* @throws IOException - if an error occurs opening the InputStream
*/
static InputStream getInputStream(String path) throws IOException {
new ClassPathResource(path).getInputStream()
}
/**
* Construct a new ClassPathResource
* @path - the path to the resource (file). The path is relative to the classpath,
* by default, but may be optionally prefixed by any of the valid java.net.URL prefixes, such
* as "file:" (to load from a relative or absolute path on the filesystem), or "http:". The
* path must not be empty or null.
*/
ClassPathResource(String path) {
assert path
this.path = path
}
/**
* Open an InputStream on the classpath resource path
* @throws IOException - if an error occurs opening the InputStream
*/
InputStream getInputStream() throws IOException {
def inputStream = getClass().classLoader.getResourceAsStream(path)
if (!inputStream) {
throw new FileNotFoundException("File [$path] does not exist or is not accessible")
}
inputStream
}
/**
* @return true only if this resource exists and is accessible
*/
boolean exists() {
def inputStream
try {
inputStream = getClass().classLoader.getResourceAsStream(path)
return inputStream != null
}
catch (IOException e) {
return false
}
finally {
if (inputStream) {
inputStream.close()
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/io/DefaultResourceFactory.groovy 0000644 0001750 0001750 00000003233 12311373552 027333 0 ustar ebourg ebourg /*
* 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.util.io
/**
* Default implementation of ResourceFactory.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class DefaultResourceFactory implements ResourceFactory {
private static final String CLASSPATH_PREFIX = 'classpath:'
/**
* Return a Resource instance suitable for the specified path.
* @param path - the path to the resource. Must not be null or empty. This may be
* optionally prefixed by "classpath:" or any of the valid java.net.URL prefixes
* (e.g., "file:", "http:")
* @throws IOException - if an error occurs opening the InputStream
*/
Resource getResource(String path) throws IOException {
assert path
if (path.startsWith(CLASSPATH_PREFIX)) {
return new ClassPathResource(path - CLASSPATH_PREFIX)
}
isUrl(path) ? new UrlResource(path) : new ClassPathResource(path)
}
private isUrl(String path) {
path =~ /.*\:.*/
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/io/ResourceFactory.groovy 0000644 0001750 0001750 00000002254 12311373552 026030 0 ustar ebourg ebourg /*
* 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.util.io
/**
* Defines the interface for factory objects that create/return Resource instances.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
interface ResourceFactory {
/**
* Return a Resource instance suitable for the specified path.
* @param path - the path to the resource. This may be optionally prefixed by
* @throws IOException - if an error occurs opening the InputStream
*/
Resource getResource(String path) throws IOException
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/WildcardPattern.groovy 0000644 0001750 0001750 00000012126 12311373552 025370 0 ustar ebourg ebourg /*
* 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.util
/**
* Represents a string pattern that may optionally include wildcards ('*', '**' or '?'), and
* provides an API to determine whether that pattern matches a specified input string.
*
* The wildcard character '*' within the pattern matches a sequence of zero or more characters within a
* single file or directory name in the input string. It does not match a sequence of two or more
* dir/file names. For instance, 'a*b' matches 'a12345b' and 'ab', but does NOT match 'a/b' or 'a123/b'.
*
* The '**' wildcard matches any sequence of zero or more characters in the input string, including
* directory names and separators . It matches any part of the directory tree. For instance, 'a**b'
* matches 'a12345b', 'ab', 'a/b' and 'a1/a2/a3b'.
*
* The wildcard character '?' within the pattern matches exactly one character in the input string,
* excluding the normalized file separator character ('/').
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class WildcardPattern {
private final List regexes = []
private final List strings = []
private final defaultMatches
/**
* Construct a new WildcardPattern instance on a single pattern or a comma-separated list of patterns.
* @param patternString - the pattern string, optionally including wildcard characters ('*' or '?');
* may optionally contain more than one pattern, separated by commas; may be null or empty to always match
* @param defaultMatches - a boolean indicating whether matches() should
* return true if the pattern string is either empty or null. This parameter is
* optional and defaults to true.
*/
WildcardPattern(String patternString, boolean defaultMatches=true) {
this.defaultMatches = defaultMatches
def patterns = patternString ? patternString.tokenize(',') : []
patterns.each { pattern ->
if (containsWildcards(pattern)) {
regexes << convertStringWithWildcardsToRegex(pattern.trim())
}
else {
strings << pattern.trim()
}
}
}
/**
* Return true if the specified String matches the pattern or if the original
* patternString (specified in the constructor) was null or empty and the
* value for defaultMatches (also specified in the constructor) was true.
* @param string - the String to check
* @return true if the String matches the pattern
*/
boolean matches(String string) {
if (regexes.empty && strings.empty) {
return defaultMatches
}
regexes.find { regex -> string ==~ regex } ||
strings.contains(string)
}
/**
* Return true if the specified String contains one or more wildcard characters ('?' or '*')
* @param string - the String to check
* @return true if the String contains wildcards
*/
private static boolean containsWildcards(String string) {
string =~ /\*|\?/
}
/**
* Convert the specified String, optionally containing wildcards (? or *), to a regular expression String
*
* @param stringWithWildcards - the String to convert, optionally containing wildcards (? or *)
* @return an equivalent regex String
*
* @throws AssertionError - if the stringWithWildcards is null
*/
@SuppressWarnings('DuplicateLiteral')
private static String convertStringWithWildcardsToRegex(String stringWithWildcards) {
assert stringWithWildcards != null
def result = new StringBuffer()
def prevCharWasStar = false
stringWithWildcards.each { ch ->
switch (ch) {
case '*':
// Single '*' matches single dir/file; Double '*' matches sequence of zero or more dirs/files
result << (prevCharWasStar ? /.*/ : /[^\/]*/)
prevCharWasStar = !prevCharWasStar
break
case '?':
// Any character except the normalized file separator ('/')
result << /[^\/]/
break
case ['$', '|', '[', ']', '(', ')', '.', ':', '{', '}', '\\', '^', '+']:
result << '\\' + ch
break
default: result << ch
}
}
result
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/util/ModifiersUtil.groovy 0000644 0001750 0001750 00000007375 12463441374 025100 0 ustar ebourg ebourg /*
* Copyright 2012 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.util
import org.codehaus.groovy.ast.MethodNode
/**
* Provide static utility methods for parsing AST member modifiers, e.g. public/protected/private, static, final, etc.
*
* @author Chris Mair
*/
class ModifiersUtil {
private static final MODIFIERS = [
public:MethodNode.ACC_PUBLIC,
protected:MethodNode.ACC_PROTECTED,
private:MethodNode.ACC_PRIVATE,
static:MethodNode.ACC_STATIC,
final:MethodNode.ACC_FINAL,
volatile:MethodNode.ACC_VOLATILE,
transient:MethodNode.ACC_TRANSIENT
]
static boolean matchesAnyModifiers(Integer actualModifiers, List expectedModifiersList) {
if (actualModifiers == null) {
return true
}
return expectedModifiersList.any { expectedModifiers -> matchesModifiers(actualModifiers, expectedModifiers) }
}
/**
* Return true only if the actualModifiers int value contains all of the bits (enabled) from the expectedModifiers
* @param actualModifiers - the full actual modifiers; an int value of the OR-ed modifiers (values from Opcodes)
* @param expectedModifiers - the modifiers to check against; an int value of the OR-ed modifiers (values from Opcodes)
* @return true only if the actualModifiers contains all of the bits (enabled) from the expectedModifiers
*/
static boolean matchesModifiers(Integer actualModifiers, Integer expectedModifiers) {
if (actualModifiers && expectedModifiers) {
return (actualModifiers & expectedModifiers) == expectedModifiers
}
return true
}
/**
* Parse comma-separated list of modifier groups
* @param modifiersString - comma-separated list of modifier groups;
* each group is a list of whitespace-delimited modifier names;
* e.g. "public, protected static, protected final"
* @return a List of the modifiers, one int value for each group (separated by commas)
*/
static List parseModifiersList(String modifiersString) {
def groups = modifiersString?.tokenize(',')
return groups.collect { group -> parseModifiers(group) }
}
/**
* Parse a group of whitespace-delimited modifier names
* @param modifiersString - a group of whitespace-delimited modifier names
* @return the int value of the OR-ed modifiers (values from Opcodes)
*/
static int parseModifiers(String modifiersString) {
def tokens = modifiersString?.tokenize()
def mod = 0
tokens.each { token ->
mod = mod | parseSingleModifier(token)
}
return mod
}
/**
* Parse a single modifier name
* @param name - a modifier name; e.g. "public", "private", "static", "final"
* @return the int value for the modifier from Opcodes
*/
private static int parseSingleModifier(String name) {
def mod = MODIFIERS[name]
assert mod != null, "The modifier $name is not supported"
return mod
}
// Prevent instantiation; all members are static
private ModifiersUtil() { }
}
CodeNarc-0.23/src/main/groovy/org/codenarc/CodeNarc.groovy 0000644 0001750 0001750 00000017330 12403723620 023001 0 ustar ebourg ebourg /*
* Copyright 2012 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
import org.codenarc.analyzer.FilesystemSourceAnalyzer
import org.codenarc.analyzer.SourceAnalyzer
import org.codenarc.report.HtmlReportWriter
import org.codenarc.report.ReportWriterFactory
/**
* Command-line runner for CodeNarc.
*
* The supported command-line parameters are all of the form: "-OPTION=VALUE", where OPTION is one
* of the options in the following list.
*
*
help - Display the command-line help; If present, this must be the only command-line parameter.
*
basedir - The base directory for the source code to be analyzed. This is the root of the
* directory tree. Defaults to the current directory ('.').
*
rulesetfiles - The path to the Groovy or XML RuleSet definition files, relative to the classpath. This can be a
* single file path, or multiple paths separated by commas. Defaults to "rulesets/basic.xml".
*
includes - The comma-separated list of Ant file patterns specifying files that must be included;
* all files are included when omitted.
*
excludes - The comma-separated list of Ant file patterns specifying files that must be excluded;
* no files are excluded when omitted.
*
title - The title description for this analysis; used in the output report(s). Optional.
*
report - The definition of the report to produce. The option value is of the form TYPE[:FILENAME].
* where TYPE is 'html' and FILENAME is the filename (with optional path) of the output report filename.
* If the report filename is omitted, the default filename is used ("CodeNarcReport.html").
* If no report option is specified, defaults to a single 'html' report with the default filename.
*
*
*
* @author Chris Mair
*/
@SuppressWarnings(['Println', 'PrintStackTrace'])
class CodeNarc {
protected static final HELP = """CodeNarc - static analysis for Groovy',
Usage: java org.codenarc.CodeNarc [OPTIONS]
where OPTIONS are zero or more command-line options of the form "-NAME[=VALUE]":
-basedir=
The base (root) directory for the source code to be analyzed.
Defaults to the current directory (".").
-includes=
The comma-separated list of Ant-style file patterns specifying files that must
be included. Defaults to "**/*.groovy".
-excludes=
The comma-separated list of Ant-style file patterns specifying files that must
be excluded. No files are excluded when omitted.
-rulesetfiles=
The path to the Groovy or XML RuleSet definition files, relative to the classpath.
This can be a single file path, or multiple paths separated by commas.
Defaults to "rulesets/basic.xml"
-title=
The title descriptive for this analysis; used in the output report(s). Optional.
-report=
The definition of the report to produce. The option value is of the form
TYPE[:FILENAME], where TYPE is "html", "text", "xml", or "console" and FILENAME is the filename (with
optional path) of the output report filename. If the report filename is
omitted, the default filename is used for the specified report type
("CodeNarcReport.html" for "html" and "CodeNarcXmlReport.xml" for "xml"). If no
report option is specified, default to a single "html" report with the
default filename.
-help
Display the command-line help. If present, this must be the only command-line parameter.
Example command-line invocations:
java org.codenarc.CodeNarc
java org.codenarc.CodeNarc -rulesetfiles="rulesets/basic.xml" title="My Project"
java org.codenarc.CodeNarc -report=xml:MyXmlReport.xml -report=html
java org.codenarc.CodeNarc -help'"""
protected String ruleSetFiles
protected String baseDir
protected String includes
protected String excludes
protected String title
protected List reports = []
// Abstract creation of the CodeNarcRunner instance to allow substitution of test spy for unit tests
protected createCodeNarcRunner = { new CodeNarcRunner() }
// Abstract calling System.exit() to allow substitution of test spy for unit tests
protected static systemExit = { exitCode -> System.exit(exitCode) }
/**
* Main command-line entry-point. Run the CodeNarc application.
* @param args - the String[] of command-line arguments
*/
static void main(String[] args) {
def codeNarc = new CodeNarc()
if (args == ['-help'] as String[]) {
println HELP
return
}
try {
codeNarc.execute(args)
}
catch(Throwable t) {
println "ERROR: ${t.message}"
t.printStackTrace()
println HELP
systemExit(1)
}
}
protected void execute(String[] args) {
parseArgs(args)
setDefaultsIfNecessary()
def sourceAnalyzer = createSourceAnalyzer()
reports.each { reportWriter -> reportWriter.title = title }
def codeNarcRunner = createCodeNarcRunner()
codeNarcRunner.ruleSetFiles = ruleSetFiles
codeNarcRunner.reportWriters = reports
codeNarcRunner.sourceAnalyzer = sourceAnalyzer
codeNarcRunner.execute()
}
protected void setDefaultsIfNecessary() {
baseDir = baseDir ?: '.'
includes = includes ?: '**/*.groovy'
ruleSetFiles = ruleSetFiles ?: 'rulesets/basic.xml'
if (reports.empty) {
reports << new HtmlReportWriter(title:title)
}
}
/**
* Create and return the SourceAnalyzer
* @return a configured SourceAnalyzer instance
*/
protected SourceAnalyzer createSourceAnalyzer() {
new FilesystemSourceAnalyzer(baseDirectory: baseDir, includes: includes, excludes: excludes)
}
protected void parseArgs(String[] args) {
args.each { arg ->
final PATTERN = /\-(.*)\=(.*)/ // -name=value
def matcher = arg =~ PATTERN
assert matcher, "Invalid argument format: [$arg]"
def name = matcher[0][1]
def value = matcher[0][2]
switch(name) {
case 'rulesetfiles': ruleSetFiles = value; break
case 'basedir': baseDir = value; break
case 'includes': includes = value; break
case 'excludes': excludes = value; break
case 'title': title = value; break
case 'report': parseReport(value); break
default: throw new IllegalArgumentException("Invalid option: [$arg]")
}
}
}
private parseReport(String argValue) {
def parts = argValue.split(':', 2)
def type = parts[0]
def reportWriter = new ReportWriterFactory().getReportWriter(type)
if (parts.size() > 1 && parts[1]) {
reportWriter.outputFile = parts[1]
}
reports << reportWriter
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleregistry/ 0000755 0001750 0001750 00000000000 12623571301 022611 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/ruleregistry/RuleRegistryHolder.groovy 0000644 0001750 0001750 00000001504 12006632014 027650 0 ustar ebourg ebourg /*
* Copyright 2011 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.ruleregistry
/**
* Holds a reference to the RuleRegistry static singleton
*
* @author Chris Mair
*/
class RuleRegistryHolder {
static RuleRegistry ruleRegistry
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleregistry/RuleRegistryInitializer.groovy 0000644 0001750 0001750 00000001700 12006632016 030716 0 ustar ebourg ebourg /*
* Copyright 2011 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.ruleregistry
/**
* Performs initialization (loading) of the RuleRegistry singleton held by RuleRegistryHolder
*
* @author Chris Mair
*/
class RuleRegistryInitializer {
void initializeRuleRegistry() {
RuleRegistryHolder.ruleRegistry = new PropertiesFileRuleRegistry()
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleregistry/RuleRegistry.groovy 0000644 0001750 0001750 00000001515 12006632012 026512 0 ustar ebourg ebourg /*
* 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.ruleregistry
/**
* Represents a registry of rule classes, accessible by rule name
*
* @author Chris Mair
*/
interface RuleRegistry {
Class getRuleClass(String ruleName)
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ruleregistry/PropertiesFileRuleRegistry.groovy 0000644 0001750 0001750 00000004250 12006632016 031372 0 ustar ebourg ebourg /*
* Copyright 2011 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.ruleregistry
import org.apache.log4j.Logger
import org.codenarc.util.io.ClassPathResource
/**
* Implementation of RuleRegistry that loads the rules from the 'codenarc-base-rules.properties' properties file.
*
* @see org.codenarc.tool.GenerateCodeNarcRulesProperties
*
* @author Chris Mair
*/
class PropertiesFileRuleRegistry implements RuleRegistry {
private static final LOG = Logger.getLogger(PropertiesFileRuleRegistry)
private static final PROPERTIES_FILENAME = 'codenarc-base-rules.properties'
public static final PROPERTIES_FILE = "src/main/resources/$PROPERTIES_FILENAME"
private Properties properties
PropertiesFileRuleRegistry() {
loadRules()
}
/**
* Return the Rule Class for the specified name or else null
* @param ruleName - the rule name
* @return the associated Rule Class or null if no Rule has been registered for the specified name
*/
Class getRuleClass(String ruleName) {
String className = properties[ruleName]
return className ? PropertiesFileRuleRegistry.getClassLoader().loadClass(className) : null
}
private void loadRules() {
def startTime = System.currentTimeMillis()
def inputStream = ClassPathResource.getInputStream(PROPERTIES_FILENAME)
properties = new Properties()
properties.load(inputStream)
def elapsedTime = System.currentTimeMillis() - startTime
LOG.info("Loaded properties file in ${elapsedTime}ms; ${properties.size()} rules")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/test/ 0000755 0001750 0001750 00000000000 12623571301 021030 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/test/TestUtil.groovy 0000644 0001750 0001750 00000014560 12041056140 024053 0 ustar ebourg ebourg /*
* Copyright 2012 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.test
import org.apache.log4j.Logger
import org.apache.log4j.spi.LoggingEvent
/**
* Contains common static utility methods for tests
*
* @author Chris Mair
*/
class TestUtil {
/**
* Assert that the specified code throws an exception of the specified type. Return the thrown exception message.
* @param expectedExceptionClass - the Class of exception that is expected; may be null
* @param code - the Closure containing the code to be executed, which is expected to throw an exception of the specified type
* @return the message from the thrown Exception
*
* @throws AssertionError - if no exception is thrown by the code or if the thrown exception is not of the expected type
*/
static String shouldFail(Class expectedExceptionClass, Closure code) {
def actualException = null
try {
code.call()
} catch (Throwable thrown) {
actualException = thrown
}
assert actualException, "No exception thrown. Expected [${expectedExceptionClass?.getName()}]"
if (expectedExceptionClass) {
assert expectedExceptionClass.isAssignableFrom(actualException.class), "Expected [${expectedExceptionClass.getName()}] but was [${actualException.class.name}]"
}
return actualException.getMessage()
}
/**
* Assert that the specified code throws an exception (of any type). Return the thrown exception message.
* @param code - the Closure containing the code to be executed, which is expected to throw an exception of the specified type
* @return the message from the thrown Exception
*
* @throws AssertionError - if no exception is thrown by the code or if the thrown exception is not of the expected type
*/
static String shouldFail(Closure code) {
shouldFail(null, code)
}
/**
* Assert that the specified code throws an exception whose message contains the specified text.
* @param expectedExceptionClass - the class of the Throwable that is expected to be thrown
* @param expectedText - the text expected within the exception message
* @param code - the Closure containing the code to be executed, which is expected to throw an exception of the specified type
* @return the thrown Exception message
*
* @throws AssertionError - if no exception is thrown by the code or if the text is not contained in the exception message
*/
static String shouldFailWithMessageContaining(Class expectedExceptionClass, String expectedText, Closure code) {
def msg = shouldFail(expectedExceptionClass, code)
assert msg?.contains(expectedText), "Message [$msg] does not contain [$expectedText]"
return msg
}
/**
* Assert that the specified closure should throw an exception whose message contains text
* @param text - the text expected within the message; may be a single String or a List of Strings
* @param closure - the Closure to execute
*/
static void shouldFailWithMessageContaining(text, Closure closure) {
def message = shouldFail(closure)
def strings = text instanceof List ? text : [text]
strings.each { string ->
assert message.contains(string), "[$message] does not contain [$string]"
}
}
/**
* Return true if the text contains each of the specified strings
* @param text - the text to search
* @param strings - the Strings to check for; toString() is invoked on each element
*/
static boolean containsAll(String text, strings) {
strings.every { text.contains(it.toString()) }
}
/**
* Assert that the text contains each of the specified strings
* @param text - the text to search
* @param strings - the Strings that must be present within text; toString() is invoked on each element
*/
static void assertContainsAll(String text, strings) {
strings.each { assert text.contains(it.toString()), "text does not contain [$it]" }
}
/**
* Assert that the text contains each of the specified strings, in order
* @param text - the text to search
* @param strings - the Strings that must be present within text, and appear
* in the order specified; toString() is applied to each.
*/
static void assertContainsAllInOrder(String text, strings) {
def startIndex = 0
strings.each { string ->
def index = text.indexOf(string.toString(), startIndex)
assert index > -1, "text does not contain [$string]"
startIndex = index + 1
}
}
/**
* Assert that the two collections have equal Sets of elements. In other words, assert that
* the two collections are the same, ignoring ordering and duplicates.
*/
static void assertEqualSets(Collection collection1, Collection collection2) {
assert collection1 as Set == collection2 as Set
}
static String captureSystemOut(Closure closure) {
def originalSystemOut = System.out
def outputStream = new ByteArrayOutputStream()
try {
System.out = new PrintStream(outputStream)
closure()
}
finally {
System.out = originalSystemOut
}
outputStream.toString()
}
static List captureLog4JMessages(Closure closure) {
def inMemoryAppender = new InMemoryAppender()
def logger = Logger.rootLogger
logger.addAppender(inMemoryAppender)
try {
closure()
}
finally {
logger.removeAppender(inMemoryAppender)
}
return inMemoryAppender.getLoggingEvents()
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/test/InMemoryAppender.groovy 0000644 0001750 0001750 00000002723 12311373552 025523 0 ustar ebourg ebourg /*
* Copyright 2012 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.test
import org.apache.log4j.AppenderSkeleton
import org.apache.log4j.spi.LoggingEvent
/**
* Log4J Appender that saves all logged loggingEvents in a List.
*
* @author Chris Mair
*/
class InMemoryAppender extends AppenderSkeleton implements Closeable {
private final List loggingEvents = []
/**
* Return the List of LoggingEvents logged to this Appender
* @return the List of logged LoggingEvents
*/
List getLoggingEvents() {
return loggingEvents
}
void clearLoggedMessages() {
loggingEvents.clear()
}
protected void append(LoggingEvent loggingEvent) {
loggingEvents.add(loggingEvent)
}
@Override
void close() {
// Do nothing
}
boolean requiresLayout() {
return false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/test/AbstractTestCase.groovy 0000644 0001750 0001750 00000004172 12311373552 025504 0 ustar ebourg ebourg /*
* Copyright 2012 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.test
import org.apache.log4j.Logger
import org.junit.Before
import org.junit.Rule
import org.junit.rules.TestName
/**
* Abstract superclass for tests
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
@SuppressWarnings(['AbstractClassWithoutAbstractMethod', 'ConfusingMethodName'])
abstract class AbstractTestCase {
protected static final CODENARC_PROPERTIES_FILE_PROP = 'codenarc.properties.file'
@SuppressWarnings('FieldName')
protected final LOG = Logger.getLogger(getClass())
@SuppressWarnings('PublicInstanceField')
@Rule public TestName testName = new TestName()
/**
* Write out the specified log message, prefixing with the current class name.
* @param message - the message to log; toString() is applied first
*/
protected void log(message) {
LOG.info message
}
protected String getName() {
return testName.getMethodName()
}
private String classNameNoPackage() {
def className = getClass().name
def index = className.lastIndexOf('.')
(index > -1) ? className[index + 1 .. -1] : className
}
//------------------------------------------------------------------------------------
// Test Setup and Tear Down
//------------------------------------------------------------------------------------
@Before
void setUpAbstractTestCase() {
log "----------[ ${classNameNoPackage()}.${getName()} ]----------"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/analyzer/ 0000755 0001750 0001750 00000000000 12623571301 021676 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/analyzer/AbstractSourceAnalyzer.groovy 0000644 0001750 0001750 00000003617 12253152040 027600 0 ustar ebourg ebourg /*
* 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.analyzer
import org.codenarc.rule.Rule
import org.codenarc.rule.Violation
import org.codenarc.ruleset.RuleSet
import org.codenarc.source.CustomCompilerPhaseSourceDecorator
import org.codenarc.source.SourceCode
/**
* Common functionality for SourceAnalyzers.
*/
@SuppressWarnings('AbstractClassWithoutAbstractMethod')
abstract class AbstractSourceAnalyzer implements SourceAnalyzer {
protected List collectViolations(SourceCode sourceCode, RuleSet ruleSet) {
def allViolations = []
def suppressionService = sourceCode.suppressionAnalyzer
def validRules = ruleSet.rules.findAll { !suppressionService.isRuleSuppressed(it) }
def sourceAfterPhase = [(SourceCode.DEFAULT_COMPILER_PHASE): sourceCode].withDefault { phase ->
new CustomCompilerPhaseSourceDecorator(sourceCode, phase)
}
for (Rule rule: validRules) {
def sourceAfterRequiredPhase = sourceAfterPhase[rule.compilerPhase]
def violations = rule.applyTo(sourceAfterRequiredPhase)
violations.removeAll { suppressionService.isViolationSuppressed(it) }
allViolations.addAll(violations)
}
allViolations.sort { it.lineNumber }
allViolations
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/analyzer/SourceAnalyzer.groovy 0000644 0001750 0001750 00000002623 12311373552 026120 0 ustar ebourg ebourg /*
* Copyright 2008 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.analyzer
import org.codenarc.results.Results
import org.codenarc.ruleset.RuleSet
/**
* The interface for objects that can analyze the source files within one or more directory
* trees using a specified RuleSet and produce report results.
*
* @author Chris Mair
*/
interface SourceAnalyzer {
/**
* Analyze all source code using the specified RuleSet and return the report results.
* @param ruleset - the RuleSet to apply to each source component; must not be null.
* @return the results from applying the RuleSet to all of the source
*/
Results analyze(RuleSet ruleSet)
/**
* Return the List of source directories to be analyzed. May be empty; may not be null.
*/
List getSourceDirectories()
}
CodeNarc-0.23/src/main/groovy/org/codenarc/analyzer/SuppressionAnalyzer.java 0000644 0001750 0001750 00000017455 12006632012 026605 0 ustar ebourg ebourg package org.codenarc.analyzer;
import org.codehaus.groovy.ast.*;
import org.codehaus.groovy.ast.expr.ConstantExpression;
import org.codehaus.groovy.ast.expr.Expression;
import org.codehaus.groovy.ast.expr.ListExpression;
import org.codenarc.rule.Rule;
import org.codenarc.rule.Violation;
import org.codenarc.source.SourceCode;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
/**
* This class encapsulates all of the logic for determining if an rule is suppressed or not.
*/
public class SuppressionAnalyzer {
private static final ClassNode SUPPRESS_WARNINGS = ClassHelper.make(SuppressWarnings.class);
private final SourceCode source;
private boolean initialized = false;
private final Object initializationLock = new Object();
private final Set suppressedRuleNames = Collections.synchronizedSet(new HashSet());
private final Map suppressionsByLineNumber = new ConcurrentHashMap();
public SuppressionAnalyzer(SourceCode source) {
this.source = source;
}
public boolean isRuleSuppressed(Rule rule) {
init();
return suppressedRuleNames.contains(rule.getName());
}
public List filterSuppressedViolations(Iterable violations) {
List result = new ArrayList();
if (violations == null) return result;
for (Violation v : violations) {
if (!isViolationSuppressed(v)) {
result.add(v);
}
}
return result;
}
public boolean isViolationSuppressed(Violation violation) {
if (violation == null) return false;
if (violation.getRule() == null) return false;
if (violation.getRule().getName() == null) return false;
if (violation.getLineNumber() == null) return false;
if (violation.getLineNumber() < 0) return false;
init();
String ruleName = violation.getRule().getName();
int lineNumber = violation.getLineNumber();
BitSet lines = suppressionsByLineNumber.get(ruleName);
if (lines != null) {
return lines.get(lineNumber);
}
return false;
}
private void init() {
synchronized (initializationLock) {
if (!initialized) {
ModuleNode ast = source.getAst();
if (ast != null) {
suppressedRuleNames.addAll(getSuppressedRuleNames(ast.getPackage()));
suppressedRuleNames.addAll(getSuppressedRuleNames(ast.getImports()));
suppressedRuleNames.addAll(getSuppressedRuleNames(ast.getStaticStarImports().values()));
suppressedRuleNames.addAll(getSuppressedRuleNames(ast.getStarImports()));
// if it is the only class in the file, then a @SuppressWarnings applies to everything
if (ast.getClasses() != null && ast.getClasses().size() == 1) {
suppressedRuleNames.addAll(getSuppressedRuleNames(ast.getClasses()));
}
// build up suppressions by line number
suppressionsByLineNumber.putAll(getSuppressionsByLineNumber(ast));
}
initialized = true;
}
}
}
private Map getSuppressionsByLineNumber(ModuleNode ast) {
Map result = new HashMap();
int numLines = getLineCount(ast);
for (ClassNode classNode : ast.getClasses()) {
for (String ruleName : getSuppressedRuleNames(classNode)) {
populateLineNumbers(classNode, result, numLines, ruleName);
}
for (AnnotatedNode fieldNode : from(classNode.getFields())) {
for (String ruleName : getSuppressedRuleNames(fieldNode)) {
populateLineNumbers(fieldNode, result, numLines, ruleName);
}
}
for (AnnotatedNode methodNode : from(classNode.getMethods())) {
for (String ruleName : getSuppressedRuleNames(methodNode)) {
populateLineNumbers(methodNode, result, numLines, ruleName);
}
}
}
return result;
}
@SuppressWarnings({"unchecked"})
private static T from(T from) {
if (from != null) return from;
return (T) Collections.emptyList();
}
private static void populateLineNumbers(AnnotatedNode node, Map result, int numLines, String ruleName) {
final BitSet bits;
if (result.containsKey(ruleName)) {
bits = result.get(ruleName);
} else {
bits = new BitSet(numLines);
}
bits.set(node.getLineNumber(), node.getLastLineNumber() + 1);
result.put(ruleName, bits);
}
private static int getLineCount(ModuleNode ast) {
int highest = 0;
for (AnnotatedNode classNode : ast.getClasses()) {
if (classNode.getLastLineNumber() > highest) {
highest = classNode.getLastLineNumber();
}
}
return highest;
}
private static Collection getSuppressedRuleNames(Collection imports) {
List result = new ArrayList();
if (imports != null) {
for (AnnotatedNode node : imports) {
result.addAll(getSuppressedRuleNames(node));
}
}
return result;
}
private static Collection getSuppressedRuleNames(AnnotatedNode node) {
List result = new ArrayList();
if (node == null) return result;
Set annos = getSuppressWarningsAnnotations(node);
for (AnnotationNode annotation : annos) {
Map members = annotation.getMembers();
if (members != null) {
Collection values = members.values();
if (values != null) {
for (Expression exp : values) {
if (exp instanceof ConstantExpression && ((ConstantExpression) exp).getValue() instanceof String) {
result.add((String) ((ConstantExpression) exp).getValue());
} else if (exp instanceof ListExpression) {
List expressions = ((ListExpression) exp).getExpressions();
if (expressions != null) {
for (Expression entry : expressions) {
if (entry instanceof ConstantExpression && ((ConstantExpression) entry).getValue() instanceof String) {
result.add((String) ((ConstantExpression) entry).getValue());
}
}
}
}
}
}
}
}
return result;
}
private static Set getSuppressWarningsAnnotations(AnnotatedNode node) {
Set result = new HashSet();
result.addAll(node.getAnnotations(SUPPRESS_WARNINGS));
List annots = node.getAnnotations();
if (annots != null) {
for (AnnotationNode n : annots) {
ClassNode classNode = n.getClassNode();
if (classNode != null) {
String name = classNode.getName();
if ("SuppressWarnings".equals(name)) {
result.add(n);
} else if ("java.lang.SuppressWarnings".equals(name)) {
result.add(n);
}
}
}
}
return result;
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/analyzer/StringSourceAnalyzer.groovy 0000644 0001750 0001750 00000002336 12311373552 027310 0 ustar ebourg ebourg /*
* 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.analyzer
import org.codenarc.results.Results
import org.codenarc.results.VirtualResults
import org.codenarc.ruleset.RuleSet
import org.codenarc.source.SourceString
/**
* Analyzes Strings.
*
* @author Hamlet D'Arcy
*/
class StringSourceAnalyzer extends AbstractSourceAnalyzer {
SourceString source
StringSourceAnalyzer(String source) {
this.source = new SourceString(source)
}
Results analyze(RuleSet ruleSet) {
List allViolations = collectViolations(source, ruleSet)
new VirtualResults(allViolations)
}
List getSourceDirectories() {
[]
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/analyzer/FilesystemSourceAnalyzer.groovy 0000644 0001750 0001750 00000012274 12311373552 030170 0 ustar ebourg ebourg /*
* 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.analyzer
import org.codenarc.results.DirectoryResults
import org.codenarc.results.FileResults
import org.codenarc.results.Results
import org.codenarc.ruleset.RuleSet
import org.codenarc.source.SourceCode
import org.codenarc.source.SourceFile
import org.codenarc.util.WildcardPattern
/**
* SourceAnalyzer implementation that recursively processes files from the file system.
*
* @author Chris Mair
*/
class FilesystemSourceAnalyzer extends AbstractSourceAnalyzer {
static final SEP = '/'
static final DEFAULT_INCLUDES = '**/*.groovy'
/**
* The base (root) directory. Must not be null or empty.
*/
String baseDirectory
/**
* The ant-style pattern of files to include in the analysis. Defaults to match all
* files with names ending with '.groovy'. If null, match all
* files/directories. This pattern can optionally contain wildcards: '**', '*' and '?'.
* All file separators within paths are normalized to the standard '/' separator,
* so use the '/' separator within this pattern where necessary. Example:
* "**/*.groovy". If both includes and excludes
* are specified, then only files/directories that match at least one of the
* includes and none of the excludes are analyzed.
*/
String includes = DEFAULT_INCLUDES
/**
* The ant-style pattern of files to exclude from the analysis. If null, exclude no
* files/directories. This pattern can optionally contain wildcards: '**', '*' and '?'.
* All file separators within paths are normalized to the standard '/' separator,
* so use the '/' separator within this pattern where necessary. Example:
* "**/*.groovy". If both includes and excludes
* are specified, then only files/directories that match at least one of the
* includes and none of the excludes are analyzed.
*/
String excludes
private WildcardPattern includesPattern
private WildcardPattern excludesPattern
/**
* Analyze the source with the configured directory tree(s) using the specified RuleSet and return the report results.
* @param ruleset - the RuleSet to apply to each of the (applicable) files in the source directories
* @return the results from applying the RuleSet to all of the files in the source directories
*/
Results analyze(RuleSet ruleSet) {
assert baseDirectory
assert ruleSet
initializeWildcardPatterns()
def reportResults = new DirectoryResults()
def dirResults = processDirectory('', ruleSet)
reportResults.addChild(dirResults)
reportResults
}
List getSourceDirectories() {
[baseDirectory]
}
private DirectoryResults processDirectory(String dir, RuleSet ruleSet) {
def dirResults = new DirectoryResults(dir)
def dirFile = new File((String) baseDirectory, (String) dir)
dirFile.eachFile { file ->
def dirPrefix = dir ? dir + SEP : dir
def filePath = dirPrefix + file.name
if (file.directory) {
def subdirResults = processDirectory(filePath, ruleSet)
// If any of the descendent directories have matching files, then include in final results
if (subdirResults.getTotalNumberOfFiles(true)) {
dirResults.addChild(subdirResults)
}
}
else {
processFile(filePath, dirResults, ruleSet)
}
}
dirResults
}
private processFile(String filePath, DirectoryResults dirResults, RuleSet ruleSet) {
def file = new File((String) baseDirectory, filePath)
def sourceFile = new SourceFile(file)
if (matches(sourceFile)) {
dirResults.numberOfFilesInThisDirectory++
List allViolations = collectViolations(sourceFile, ruleSet)
if (allViolations) {
def fileResults = new FileResults(filePath, allViolations)
dirResults.addChild(fileResults)
}
}
}
protected boolean matches(SourceCode sourceFile) {
includesPattern.matches(sourceFile.path) &&
!excludesPattern.matches(sourceFile.path)
}
protected void initializeWildcardPatterns() {
includesPattern = new WildcardPattern(includes)
excludesPattern = new WildcardPattern(excludes, false) // do not match by default
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/analyzer/DirectorySourceAnalyzer.groovy 0000644 0001750 0001750 00000011622 12311373552 030004 0 ustar ebourg ebourg /*
* Copyright 2008 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.analyzer
import org.codenarc.results.DirectoryResults
import org.codenarc.results.FileResults
import org.codenarc.results.Results
import org.codenarc.ruleset.RuleSet
import org.codenarc.source.SourceCodeCriteria
import org.codenarc.source.SourceFile
/**
* SourceAnalyzer implementation that recursively processes files in the configured source directories.
*
* @deprecated This is an internal class that will be removed in the future
*
* @author Chris Mair
*/
class DirectorySourceAnalyzer extends AbstractSourceAnalyzer {
static final SEP = '/'
/**
* The base directory; the sourceDirectories are relative to this,
* if not null. If this value is null, then treat sourceDirectories as full paths.
*/
String baseDirectory
/**
* The list of source directories, relative to the baseDirectory
* if it is not null. If sourceDirectories is null, then analyze files recursively
* from baseDirectory.
*/
List sourceDirectories
/**
* Only analyze pathnames matching this regular expression. If null, match all pathnames.
* This defaults to matching all pathnames that end with '.groovy'.
*/
String applyToFilesMatching = /.*\.groovy/
/**
* Do NOT analyze pathnames matching this regular expression. If null, then do not exclude any pathnames.
*/
String doNotApplyToFilesMatching
/**
* Only analyze filenames matching this value.
* The value may optionally be a comma-separated list of names.
* The name(s) may optionally include wildcard characters ('*' or '?').
*/
String applyToFileNames
/**
* Do NOT analyze filenames matching this value.
* The value may optionally be a comma-separated list of names.
* The name(s) may optionally include wildcard characters ('*' or '?').
*/
String doNotApplyToFileNames
/**
* Analyze the source with the configured directory tree(s) using the specified RuleSet and return the report results.
* @param ruleset - the RuleSet to apply to each of the (applicable) files in the source directories
* @return the results from applying the RuleSet to all of the files in the source directories
*/
Results analyze(RuleSet ruleSet) {
assert baseDirectory || sourceDirectories
assert ruleSet
def reportResults = new DirectoryResults()
def srcDirs = sourceDirectories ?: ['']
srcDirs.each { srcDir ->
def dirResults = processDirectory(srcDir, ruleSet)
reportResults.addChild(dirResults)
}
reportResults
}
private DirectoryResults processDirectory(String dir, RuleSet ruleSet) {
def dirResults = new DirectoryResults(dir)
def dirFile = new File((String)baseDirectory, (String)dir)
dirFile.eachFile { file ->
def dirPrefix = dir ? dir + SEP : dir
def filePath = dirPrefix + file.name
if (file.directory) {
def subdirResults = processDirectory(filePath, ruleSet)
// If any of the descendent directories have matching files, then include in final results
if (subdirResults.getTotalNumberOfFiles(true)) {
dirResults.addChild(subdirResults)
}
}
else {
processFile(filePath, dirResults, ruleSet)
}
}
dirResults
}
private processFile(String filePath, DirectoryResults dirResults, RuleSet ruleSet) {
def file = new File((String)baseDirectory, filePath)
def sourceFile = new SourceFile(file)
if (new SourceCodeCriteria(
applyToFilesMatching:applyToFilesMatching,
doNotApplyToFilesMatching:doNotApplyToFilesMatching,
applyToFileNames:applyToFileNames,
doNotApplyToFileNames:doNotApplyToFileNames).matches(sourceFile)) {
dirResults.numberOfFilesInThisDirectory ++
List allViolations = collectViolations(sourceFile, ruleSet)
if (allViolations) {
def fileResults = new FileResults(filePath, allViolations)
dirResults.addChild(fileResults)
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/ 0000755 0001750 0001750 00000000000 12623571301 021020 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/ 0000755 0001750 0001750 00000000000 12623571301 023357 5 ustar ebourg ebourg ././@LongLink 0000644 0000000 0000000 00000000147 00000000000 011605 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryFinalOnPrivateMethodRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryFinalOnPrivateMethodRule.groo0000644 0001750 0001750 00000003043 12041061502 033330 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import java.lang.reflect.Modifier
/**
* A private method is marked final. Private methods cannot be overridden, so marking it final is unnecessary.
*
* @author 'Hamlet D'Arcy'
*/
class UnnecessaryFinalOnPrivateMethodRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryFinalOnPrivateMethod'
int priority = 3
Class astVisitorClass = UnnecessaryFinalOnPrivateMethodAstVisitor
}
class UnnecessaryFinalOnPrivateMethodAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
if (Modifier.isFinal(node.modifiers) && Modifier.isPrivate(node.modifiers)) {
addViolation(node, "The '$node.name' method is both private and final")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryGetterRule.groovy 0000644 0001750 0001750 00000005044 12311370173 031131 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* Checks for explicit calls to getter/accessor methods which can, for the most part, be replaced by property access.
* A getter is defined as a method call that matches get[A-Z] but not getClass() or get[A-Z][A-Z] such as getURL().
* Getters do not take method arguments.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryGetterRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryGetter'
int priority = 3
Class astVisitorClass = UnnecessaryGetterAstVisitor
}
class UnnecessaryGetterAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
addViolationsIfGetter(call)
}
private addViolationsIfGetter(MethodCallExpression call) {
if (AstUtil.getMethodArguments(call).size() != 0) {
return
}
if (!(call.method instanceof ConstantExpression)) {
return
}
String name = call.method.value
if (name == 'getClass' || name.length() < 4) {
return
}
if (name[0..2] == 'get' && (name[3] as Character).isUpperCase()) {
if (name.length() == 4) {
addViolation call, "$name() can probably be rewritten as ${name[3].toLowerCase()}"
} else if ((name[4] as Character).isLowerCase()) {
def propertyName = name[3].toLowerCase() + name[4..-1]
addViolation call, "$name() can probably be rewritten as $propertyName"
} else {
def propertyName = name[3..-1]
addViolation call, "$name() can probably be rewritten as $propertyName"
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryTernaryExpressionRule.groovy 0000644 0001750 0001750 00000012311 12311373552 033402 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.*
/**
* Rule that 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. These cases can be replaced by a simple boolean expression.
* Examples include:
*
*
boolean result = x==99 ? true : false - can be replaced by boolean result = x==99
*
boolean result = x && y ? true : false - can be replaced by boolean result = x && y
*
def result = x||y ? false : true - can be replaced by def result = !(x||y)
*
boolean result = x >= 1 ? true: false - can be replaced by boolean result = x >= 1
*
boolean result = x < 99 ? Boolean.TRUE : Boolean.FALSE - can be replaced by boolean result = x < 99
*
def result = !x ? true : false - can be replaced by def result = !x
*
*
* The rule also checks for ternary expressions where the true and false expressions are the same constant or
* variable expression. Examples include:
*
*
def result = x ? '123' : '123' - can be replaced by def result = '123'
*
def result = x ? null : null - can be replaced by def result = null
*
def result = x ? 23 : 23 - can be replaced by def result = 23
*
def result = x ? MAX_VALUE : MAX_VALUE - can be replaced by def result = MAX_VALUE
*
*
* @author Chris Mair
*/
class UnnecessaryTernaryExpressionRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryTernaryExpression'
int priority = 3
Class astVisitorClass = UnnecessaryTernaryExpressionAstVisitor
}
class UnnecessaryTernaryExpressionAstVisitor extends AbstractAstVisitor {
private static final BOOLEAN_COMPARISON_OPERATIONS = ['<', '>', '>=', '<=', '==', '!=', '==~']
private static final BOOLEAN_LOGIC_OPERATIONS = ['&&', '||']
void visitTernaryExpression(TernaryExpression ternaryExpression) {
if (isFirstVisit(ternaryExpression)) {
def trueExpression = ternaryExpression.trueExpression
def falseExpression = ternaryExpression.falseExpression
def booleanExpression = ternaryExpression.booleanExpression
if (areBothTheSame(trueExpression, falseExpression)
|| (isBooleanConditionalExpression(booleanExpression) && areTrueAndFalse(trueExpression, falseExpression))) {
addViolation(ternaryExpression, 'The ternary expression is useless or nonsensical')
}
}
super.visitTernaryExpression(ternaryExpression)
}
private boolean isBooleanConditionalExpression(BooleanExpression conditionalExpression) {
def expression = conditionalExpression.expression
if (expression instanceof NotExpression) {
return true
}
if (expression instanceof BinaryExpression && isOperationThatReturnsABoolean(expression)) {
return true
}
false
}
private boolean isOperationThatReturnsABoolean(expression) {
def operationName = expression.operation.text
if (operationName in BOOLEAN_COMPARISON_OPERATIONS) {
return true
}
if (operationName in BOOLEAN_LOGIC_OPERATIONS) {
return true
}
false
}
private boolean areBothTheSame(Expression trueExpression, Expression falseExpression) {
if (trueExpression instanceof ConstantExpression && falseExpression instanceof ConstantExpression
&& trueExpression.getValue() == falseExpression.getValue()) {
return true
}
if (trueExpression instanceof VariableExpression && falseExpression instanceof VariableExpression
&& trueExpression.getName() == falseExpression.getName()) {
return true
}
false
}
private boolean areTrueAndFalse(Expression trueExpression, Expression falseExpression) {
(AstUtil.isTrue(trueExpression) && AstUtil.isFalse(falseExpression)) ||
(AstUtil.isFalse(trueExpression) && AstUtil.isTrue(falseExpression))
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryGStringRule.groovy 0000644 0001750 0001750 00000006162 12311370173 031256 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.GStringExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* String objects should be created with single quotes, and GString objects created with double quotes. Creating normal String objects with double quotes is confusing to readers.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryGStringRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryGString'
int priority = 3
Class astVisitorClass = UnnecessaryGStringAstVisitor
}
class UnnecessaryGStringAstVisitor extends AbstractAstVisitor {
@Override
void visitConstantExpression(ConstantExpression expression) {
if (isFirstVisit(expression) && expression.value instanceof String && expression.lineNumber > -1) {
if (!expressionContainsBannedCharacters(expression)) {
suppressException(StringIndexOutOfBoundsException) {
addViolationIfDoubleQuoted(expression)
}
}
}
super.visitConstantExpression(expression)
}
private addViolationIfDoubleQuoted(ConstantExpression expression) {
def line = getSourceCode().getLines()[expression.lineNumber - 1]
def col = line[expression.columnNumber - 1]
if (col == '"') {
addViolation(expression, "The String '$expression.value' can be wrapped in single quotes instead of double quotes")
}
}
@Override
void visitGStringExpression(GStringExpression expression) {
// do not visit the string portions of the GString
visitListOfExpressions(expression.getValues())
}
@SuppressWarnings('CatchThrowable')
private static suppressException(Class exceptionType, Closure c) {
try {
c()
} catch (Throwable t) {
if (!exceptionType.getClass().isAssignableFrom(t.getClass())) {
throw t
}
}
}
private boolean expressionContainsBannedCharacters(ConstantExpression expression) {
if (expression.value.contains('$')) { return true }
if (expression.value.contains("'")) { return true }
if (expression.lineNumber == expression.lastLineNumber) { return false }
def lines = getSourceCode().getLines()
((expression.lineNumber - 1).. (expression.lastLineNumber - 1)).any {
(lines[it].contains('$')) || (lines[it].contains("'"))
}
}
}
././@LongLink 0000644 0000000 0000000 00000000151 00000000000 011600 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessarySafeNavigationOperatorRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessarySafeNavigationOperatorRule.gr0000644 0001750 0001750 00000005053 12415361352 033400 0 ustar ebourg ebourg /*
* Copyright 2014 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.unnecessary
import static org.codenarc.util.AstUtil.*
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Check for safe navigation operator (?.) applied to constants and literals, or "this" or
* "super", which can never be null.
*
* @author Chris Mair
*/
class UnnecessarySafeNavigationOperatorRule extends AbstractAstVisitorRule {
String name = 'UnnecessarySafeNavigationOperator'
int priority = 3
Class astVisitorClass = UnnecessarySafeNavigationOperatorAstVisitor
}
class UnnecessarySafeNavigationOperatorAstVisitor extends AbstractAstVisitor {
@Override
void visitPropertyExpression(PropertyExpression expression) {
checkExpression(expression, expression.objectExpression)
super.visitPropertyExpression(expression)
}
@Override
void visitMethodCallExpression(MethodCallExpression expression) {
checkExpression(expression, expression.objectExpression)
super.visitMethodCallExpression(expression)
}
private void checkExpression(Expression expression, Expression objExpr) {
// TODO Could expand this to also check for class expressions, e.g. String?.toString(), but not parsed consistently in Groovy 1.7
if (expression.safe && (isConstantOrLiteral(objExpr) || isThisReference(objExpr) || isSuperReference(objExpr) || isConstructorCall(objExpr))) {
def expressionText = '"' + objExpr.text + '"'
addViolation(expression, "The safe navigation operator (?.) is unnecessary for $expressionText in class $currentClassName")
}
}
private boolean isConstructorCall(Expression objExpr) {
return objExpr instanceof ConstructorCallExpression
}
}
././@LongLink 0000644 0000000 0000000 00000000152 00000000000 011601 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryBigDecimalInstantiationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryBigDecimalInstantiationRule.g0000644 0001750 0001750 00000003255 12006632016 033325 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codenarc.rule.AbstractAstVisitorRule
/**
* It is unnecessary to instantiate BigDecimal objects. Instead just use the decimal literal or the 'G' identifier to force the type, such as 123.45 or 123.45G.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryBigDecimalInstantiationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryBigDecimalInstantiation'
int priority = 3
Class astVisitorClass = UnnecessaryBigDecimalInstantiationAstVisitor
}
class UnnecessaryBigDecimalInstantiationAstVisitor extends UnnecessaryInstantiationAstVisitor {
UnnecessaryBigDecimalInstantiationAstVisitor() {
super(BigDecimal, [String, Double], 'G')
}
@Override
protected boolean shouldSkipViolation(Object value) {
(value instanceof String) && !value.contains('.')
}
@Override
protected boolean isTypeSuffixNecessary(argument) {
if (argument.getClass() == String) {
return !argument.contains('.')
}
return argument.getClass() in [Integer, Long]
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryModOneRule.groovy 0000644 0001750 0001750 00000003566 12311370173 031067 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Any expression mod 1 (exp % 1) is guaranteed to always return zero. This code is probably an error, and should be either (exp & 1) or (exp % 2).
*
* @author 'Hamlet D'Arcy'
*/
class UnnecessaryModOneRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryModOne'
int priority = 3
Class astVisitorClass = UnnecessaryModOneAstVisitor
}
class UnnecessaryModOneAstVisitor extends AbstractAstVisitor {
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (AstUtil.isBinaryExpressionType(expression, '%')) {
Expression rhs = expression.rightExpression
if (rhs instanceof ConstantExpression && rhs.value == 1) {
Expression lhs = expression.leftExpression
addViolation(expression, "$expression.text is guaranteed to be zero. Did you mean ($lhs.text & 1) or ($lhs.text % 2)")
}
}
super.visitBinaryExpression(expression)
}
}
././@LongLink 0000644 0000000 0000000 00000000150 00000000000 011577 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryDefInFieldDeclarationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryDefInFieldDeclarationRule.gro0000644 0001750 0001750 00000006205 12141066466 033250 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.ClassHelper
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
/**
* If a field has a visibility modifier or a type declaration, then the def keyword is unneeded. For instance,
* 'static def constraints = {}' is redundant and can be simplified to 'static constraints = {}.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryDefInFieldDeclarationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryDefInFieldDeclaration'
int priority = 3
Class astVisitorClass = UnnecessaryDefInFieldDeclarationAstVisitor
}
class UnnecessaryDefInFieldDeclarationAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
String declaration = AstUtil.getDeclaration(node, sourceCode)
def definitionStart = declaration.indexOf('=')
if (definitionStart != -1) {
declaration = declaration[0 .. definitionStart - 1]
}
if (contains(declaration, 'def')) {
if (contains(declaration, 'private')) {
addViolation(node, 'The def keyword is unneeded when a field is marked private')
} else if (contains(declaration, 'protected')) {
addViolation(node, 'The def keyword is unneeded when a field is marked protected')
} else if (contains(declaration, 'public')) {
addViolation(node, 'The def keyword is unneeded when a field is marked public')
} else if (contains(declaration, 'static')) {
addViolation(node, 'The def keyword is unneeded when a field is marked static')
} else if (contains(declaration, 'final')) {
addViolation(node, 'The def keyword is unneeded when a field is marked final')
} else if (contains(declaration, 'strictfp')) {
addViolation(node, 'The def keyword is unneeded when a field is marked strictfp')
} else if (contains(declaration, 'Object')) {
addViolation(node, 'The def keyword is unneeded when a field is specified Object type')
} else if (node.type != ClassHelper.DYNAMIC_TYPE) {
addViolation(node, 'The def keyword is unneeded when a field type is specified')
}
}
}
private static boolean contains(String declaration, String modifier) {
declaration?.startsWith(modifier) || declaration?.contains(' ' + modifier + ' ')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/AddEmptyStringRule.groovy 0000644 0001750 0001750 00000003442 12006632014 030351 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Finds empty string literals which are being added. This is an inefficient way to convert any type to a String.
*
* @author Hamlet D'Arcy
*/
class AddEmptyStringRule extends AbstractAstVisitorRule {
String name = 'AddEmptyString'
int priority = 2
Class astVisitorClass = AddEmptyStringAstVisitor
}
class AddEmptyStringAstVisitor extends AbstractAstVisitor {
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (isFirstVisit(expression) && AstUtil.isBinaryExpressionType(expression, '+')) {
if (expression.leftExpression instanceof ConstantExpression && expression.leftExpression.value == '') {
addViolation expression, 'Concatenating an empty string is an inefficient way to convert an object to a String. Consider using toString() or String.valueOf(Object)'
}
}
super.visitBinaryExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryReturnKeywordRule.groovy 0000644 0001750 0001750 00000004747 12006632014 032530 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.ReturnStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* In Groovy, the return keyword is often optional. If a statement is the last line in a method or closure then you do not need to have the return keyword.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryReturnKeywordRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryReturnKeyword'
int priority = 3
Class astVisitorClass = UnnecessaryReturnKeywordAstVisitor
}
class UnnecessaryReturnKeywordAstVisitor extends AbstractAstVisitor {
void visitMethodEx(MethodNode node) {
def lastStatement = getLastStatement(node)
if (lastStatement instanceof ReturnStatement && !(lastStatement.expression instanceof ClosureExpression)) {
addViolation lastStatement, 'The return keyword is not needed and can be removed'
}
super.visitMethodEx node
}
void visitClosureExpression(ClosureExpression node) {
def lastStatement = getLastStatement(node)
if (lastStatement instanceof ReturnStatement && !(lastStatement.expression instanceof ClosureExpression)) {
addViolation lastStatement, 'The return keyword is not needed and can be removed'
}
super.visitClosureExpression node
}
/**
* This is not a good general function for AstUtils.
* It is too specific and may not work across different ASTNode subtypes.
* @param node
* node
*/
private static getLastStatement(node) {
if (node.code instanceof BlockStatement && node.code.statements) {
return node.code.statements.last()
}
null
}
}
././@LongLink 0000644 0000000 0000000 00000000154 00000000000 011603 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryNullCheckBeforeInstanceOfRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryNullCheckBeforeInstanceOfRule0000644 0001750 0001750 00000004646 12006632012 033321 0 ustar ebourg ebourg /*
* Copyright 2012 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.unnecessary
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* There is no need to check for null before an instanceof; the instanceof keyword returns false when given a null argument.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class UnnecessaryNullCheckBeforeInstanceOfRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryNullCheckBeforeInstanceOf'
int priority = 3
Class astVisitorClass = UnnecessaryNullCheckBeforeInstanceOfAstVisitor
}
class UnnecessaryNullCheckBeforeInstanceOfAstVisitor extends AbstractAstVisitor {
@Override
void visitBinaryExpression(BinaryExpression exp) {
if (exp.operation.text == '&&') {
if (AstUtil.isNotNullCheck(exp.leftExpression) || AstUtil.isNotNullCheck(exp.rightExpression)) {
if (AstUtil.isInstanceOfCheck(exp.leftExpression) || AstUtil.isInstanceOfCheck(exp.rightExpression)) {
addViolationIfTargetsMatch(exp)
}
}
}
super.visitBinaryExpression(exp)
}
private addViolationIfTargetsMatch(BinaryExpression exp) {
def nullTarget = AstUtil.getNullComparisonTarget(exp.leftExpression) ?: AstUtil.getNullComparisonTarget(exp.rightExpression)
def instanceofTarget = AstUtil.getInstanceOfTarget(exp.leftExpression) ?: AstUtil.getInstanceOfTarget(exp.rightExpression)
if (nullTarget && instanceofTarget && nullTarget == instanceofTarget) {
def suggestion = AstUtil.isInstanceOfCheck(exp.leftExpression) ? exp.leftExpression.text : exp.rightExpression.text
addViolation(exp, "The condition $exp.text can be safely simplified to $suggestion")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryPackageReferenceRule.groovy 0000644 0001750 0001750 00000013556 12314144004 033053 0 ustar ebourg ebourg /*
* Copyright 2012 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.unnecessary
import static org.codenarc.util.AstUtil.AUTO_IMPORTED_CLASSES
import static org.codenarc.util.AstUtil.AUTO_IMPORTED_PACKAGES
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.GroovyVersion
import org.codenarc.util.ImportUtil
import org.codehaus.groovy.ast.expr.*
/**
* Checks for explicit package reference for classes that Groovy imports by default, such as java.lang.String,
* java.util.Map and groovy.lang.Closure, as well as classes that were explicitly imported.
*
* @author Chris Mair
*/
class UnnecessaryPackageReferenceRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryPackageReference'
int priority = 3
Class astVisitorClass = UnnecessaryPackageReferenceAstVisitor
}
class UnnecessaryPackageReferenceAstVisitor extends AbstractAstVisitor {
private static final IGNORE_SUPERCLASS_NAMES = ['java.lang.Object', 'java.lang.Enum', 'groovy.lang.Script']
private final List importedClassNames = []
private final List starImportPackageNames = []
// TODO Only ignore java.util.Object superclass if it was not explicitly specified
@Override
protected void visitClassEx(ClassNode node) {
initializeImportNames()
def superClassName = node.superClass.name
if (!IGNORE_SUPERCLASS_NAMES.contains(superClassName) && !(GroovyVersion.groovy1_8_OrGreater && node.isScript() && node.name == 'None')) {
checkType(superClassName, node)
}
node.interfaces.each { interfaceNode ->
checkType(interfaceNode.name, node)
}
super.visitClassEx(node)
}
@Override
void visitField(FieldNode node) {
checkTypeIfNotDynamicallyTyped(node)
super.visitField(node)
}
@Override
void visitConstructorCallExpression(ConstructorCallExpression node) {
if (isFirstVisit(node) && !node.superCall && !node.isThisCall()) {
checkType(node.type.name, node)
}
super.visitConstructorCallExpression(node)
}
@Override
void visitVariableExpression(VariableExpression expression) {
if (isNotAutoBoxed(expression)) {
checkTypeIfNotDynamicallyTyped(expression)
}
super.visitVariableExpression(expression)
}
@Override
void visitMethodEx(MethodNode node) {
if (!node.isDynamicReturnType()) { // ignore 'def' which resolves to java.lang.Object
checkType(node.returnType.name, node)
}
node.parameters.each { parameter ->
checkTypeIfNotDynamicallyTyped(parameter)
}
super.visitMethodEx(node)
}
@Override
void visitClosureExpression(ClosureExpression expression) {
expression.parameters.each { parameter ->
checkTypeIfNotDynamicallyTyped(parameter)
}
super.visitClosureExpression(expression)
}
@Override
void visitClassExpression(ClassExpression expression) {
checkType(expression.type.name, expression)
super.visitClassExpression(expression)
}
@Override
void visitPropertyExpression(PropertyExpression expression) {
checkType(expression.text, expression)
}
@Override
void visitCastExpression(CastExpression expression) {
if (isFirstVisit(expression)) {
checkType(expression.type.name, expression)
}
super.visitCastExpression(expression)
}
//--------------------------------------------------------------------------
// Helper Methods
//--------------------------------------------------------------------------
private initializeImportNames() {
sourceCode.ast.imports.each { importNode ->
importedClassNames << importNode.className
}
sourceCode.ast.starImports.each { importNode ->
starImportPackageNames << ImportUtil.packageNameForImport(importNode)
}
}
private void checkTypeIfNotDynamicallyTyped(node) {
if (!node.isDynamicTyped()) { // ignore 'def' which resolves to java.lang.Object
checkType(node.type.name, node)
}
}
private void checkType(String typeName, node) {
if (typeName in AUTO_IMPORTED_CLASSES || parentPackageName(typeName) in AUTO_IMPORTED_PACKAGES) {
addViolation(node, "Specifying the package name is not necessary for $typeName")
}
if (typeName in importedClassNames || parentPackageName(typeName) in starImportPackageNames) {
addViolation(node, "The $typeName class was explicitly imported, so specifying the package name is not necessary")
}
}
private String parentPackageName(String typeName) {
if (typeName.contains('.')) {
def lastPeriod = typeName.lastIndexOf('.')
return typeName[0..lastPeriod - 1]
}
null
}
private boolean isNotAutoBoxed(VariableExpression expression) {
return expression.type.name == expression.originType.name
}
}
././@LongLink 0000644 0000000 0000000 00000000146 00000000000 011604 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryDoubleInstantiationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryDoubleInstantiationRule.groov0000644 0001750 0001750 00000002441 12006632020 033454 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codenarc.rule.AbstractAstVisitorRule
/**
* It is unnecessary to instantiate Double objects. Instead just use the double literal or the 'D' identifier to force the type, such as 123.45d or 0.42d.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryDoubleInstantiationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryDoubleInstantiation'
int priority = 3
Class astVisitorClass = UnnecessaryDoubleInstantiationAstVisitor
}
class UnnecessaryDoubleInstantiationAstVisitor extends UnnecessaryInstantiationAstVisitor {
UnnecessaryDoubleInstantiationAstVisitor() {
super(Double, [String, Double], 'd')
}
}
././@LongLink 0000644 0000000 0000000 00000000146 00000000000 011604 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/ConsecutiveStringConcatenationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/ConsecutiveStringConcatenationRule.groov0000644 0001750 0001750 00000007131 12006632016 033447 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.GStringExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Catches concatenation of two string literals on the same line. These can safely by joined.
*
* @author Hamlet D'Arcy
*/
class ConsecutiveStringConcatenationRule extends AbstractAstVisitorRule {
String name = 'ConsecutiveStringConcatenation'
int priority = 3
Class astVisitorClass = ConsecutiveStringConcatenationAstVisitor
}
class ConsecutiveStringConcatenationAstVisitor extends AbstractAstVisitor {
private static final PRIMITIVE_TYPES = [Byte.TYPE,
Double.TYPE,
Float.TYPE,
Integer.TYPE,
Long.TYPE,
Short.TYPE]
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (AstUtil.isBinaryExpressionType(expression, '+')) {
Expression left = expression.leftExpression
Expression right = expression.rightExpression
if (areJoinableConstants(left, right)) {
if (left instanceof GStringExpression || right instanceof GStringExpression) {
addViolation(expression, "String concatenation in class $currentClassName can be joined into a single literal")
} else {
def lvalue = escape(left.value)
def rvalue = escape(right.value)
addViolation(expression, "String concatenation in class $currentClassName can be joined into the literal '${lvalue}${rvalue}'")
}
}
}
super.visitBinaryExpression(expression)
}
private static String escape(value) {
if (value instanceof String) {
return value.replaceAll('\n', '\\\\n').replaceAll("'", "\'")
}
value
}
private static boolean areJoinableConstants(Expression left, Expression right) {
if (left.lastLineNumber != right.lineNumber) {
return false
}
if (isJoinableType(left) && isJoinableType(right)) {
// don't join two numbers
if (!isNumberLiteral(left) || !isNumberLiteral(right)) {
return true
}
}
false
}
private static boolean isNumberLiteral(Expression node) {
if (!(node instanceof ConstantExpression)) { return false }
if (AstUtil.isNull(node)) { return false }
if (!node.type.isResolved()) { return false }
(Number.isAssignableFrom(node.type.typeClass) || node.type.typeClass in PRIMITIVE_TYPES)
}
private static boolean isJoinableType(Expression node) {
if (node instanceof ConstantExpression && !AstUtil.isNull(node)) {
return true
}
return node instanceof GStringExpression
}
}
././@LongLink 0000644 0000000 0000000 00000000153 00000000000 011602 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryDefInVariableDeclarationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryDefInVariableDeclarationRule.0000644 0001750 0001750 00000010174 12006632016 033230 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.ClassHelper
import org.codehaus.groovy.ast.expr.DeclarationExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* If a variable has a visibility modifier or a type declaration, then the def keyword is unneeded.
* For instance 'def private n = 2' is redundant and can be simplified to 'private n = 2'.
*
* @author 'René Scheibe'
*/
class UnnecessaryDefInVariableDeclarationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryDefInVariableDeclaration'
int priority = 3
Class astVisitorClass = UnnecessaryDefInVariableDeclarationAstVisitor
}
class UnnecessaryDefInVariableDeclarationAstVisitor extends AbstractAstVisitor {
@Override
void visitExpressionStatement(ExpressionStatement statement) {
def node = statement.expression
if (!(node instanceof DeclarationExpression)) { return }
if (!(node.leftExpression instanceof VariableExpression)) { return }
String declaration = AstUtil.getDeclaration(node, sourceCode)
if (declaration.contains('=')) {
declaration = declaration[0..(declaration.indexOf('='))] // ignore everything to the right of equals
}
if (contains(declaration, 'def')) {
if (contains(declaration, 'private')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a variable is marked private")
} else if (contains(declaration, 'protected')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a variable is marked protected")
} else if (contains(declaration, 'public')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a variable is marked public")
} else if (contains(declaration, 'static')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a variable is marked static")
} else if (contains(declaration, 'final')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a variable is marked final")
} else if (contains(declaration, 'transient')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a variable is marked transient")
} else if (contains(declaration, 'volatile')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a variable is marked volatile")
} else if (contains(declaration, 'Object')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a variable is of type Object")
} else if (node.leftExpression.type != ClassHelper.DYNAMIC_TYPE) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a variable is declared with a type")
}
}
super.visitExpressionStatement(statement)
}
static private boolean contains(String declaration, String modifier) {
return declaration?.startsWith(modifier) || declaration?.contains(' ' + modifier + ' ')
}
}
././@LongLink 0000644 0000000 0000000 00000000146 00000000000 011604 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryStringInstantiationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryStringInstantiationRule.groov0000644 0001750 0001750 00000003707 12006632016 033523 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractConstructorCallAstVisitor
/**
* Rule that checks for direct call to the String constructor that accepts a String literal.
* In almost all cases, this is unnecessary - use a String literal instead.
*
* @author Chris Mair
*/
class UnnecessaryStringInstantiationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryStringInstantiation'
int priority = 3
Class astVisitorClass = UnnecessaryStringInstantiationAstVisitor
}
class UnnecessaryStringInstantiationAstVisitor extends AbstractConstructorCallAstVisitor {
static final NEW_STRING = /new +(java\.lang\.)?String\(/
@SuppressWarnings('ExplicitCallToGetAtMethod')
protected isConstructorCallAViolation(ConstructorCallExpression constructorCall) {
def firstArgExpression = constructorCall.arguments?.expressions?.getAt(0)
constructorCall.text =~ NEW_STRING && (firstArgExpression instanceof ConstantExpression)
}
@Override protected String getViolationMessage(ConstructorCallExpression call) {
'There is typically no need to call the String constructor'
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryOverridingMethodRule.groovy 0000644 0001750 0001750 00000004464 12006632014 033151 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
/**
* The overriding method merely calls the same method defined in a superclass.
*
* @author Sven Lange
* @author Hamlet D'Arcy
*/
class UnnecessaryOverridingMethodRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryOverridingMethod'
int priority = 3
Class astVisitorClass = UnnecessaryOverridingMethodAstVisitor
}
class UnnecessaryOverridingMethodAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
if (isSingleLineMethod(node) && node.code.statements[0]?.expression instanceof MethodCallExpression) {
MethodCallExpression methodCall = node.code.statements[0].expression
if (AstUtil.isMethodCall(methodCall, 'super', node.name, node.parameters.length)) {
if (AstUtil.getParameterNames(node) == AstUtil.getArgumentNames(methodCall)) {
addViolation node, "The method $node.name contains no logic and can be safely deleted"
}
}
}
}
private static boolean isSingleLineMethod(MethodNode node) {
if (node?.code instanceof BlockStatement) {
if (node.code.statements?.size() == 1) {
if (node.code.statements[0] instanceof ExpressionStatement) {
return true
}
}
}
false
}
}
././@LongLink 0000644 0000000 0000000 00000000147 00000000000 011605 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryIntegerInstantiationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryIntegerInstantiationRule.groo0000644 0001750 0001750 00000002600 12006632016 033453 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codenarc.rule.AbstractAstVisitorRule
/**
* It is unnecessary to instantiate Integer objects. Instead just use the literal with the 'I' identifier to force the type, such as 8I or 42i.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryIntegerInstantiationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryIntegerInstantiation'
int priority = 3
Class astVisitorClass = UnnecessaryIntegerInstantiationAstVisitor
}
class UnnecessaryIntegerInstantiationAstVisitor extends UnnecessaryInstantiationAstVisitor {
UnnecessaryIntegerInstantiationAstVisitor() {
super(Integer, [String, Integer], 'i')
}
@Override
protected boolean isTypeSuffixNecessary(argument) {
return false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryElseStatementRule.groovy 0000644 0001750 0001750 00000005757 12050576634 032501 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codehaus.groovy.ast.stmt.ReturnStatement
import org.codehaus.groovy.ast.stmt.Statement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* When an if statement block ends with a return statement the else is unnecessary
*
* @author Victor Savkin
*/
class UnnecessaryElseStatementRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryElseStatement'
int priority = 3
Class astVisitorClass = UnnecessaryElseStatementAstVisitor
}
class UnnecessaryElseStatementAstVisitor extends AbstractAstVisitor {
@Override
void visitIfElse(IfStatement node) {
if (isFirstVisit(node)) {
def (allIfBlocks, theElseBlock) = collectIfsAndElses(node)
if (isValidElseBlock(theElseBlock)) {
if (allIfBlocks && allIfBlocks.every { allBranchesReturn(it.ifBlock) }) {
addViolation theElseBlock, 'When an if statement block ends with a return statement the else is unnecessary'
}
}
visited.addAll allIfBlocks
visited.add theElseBlock
}
super.visitIfElse node
}
private static collectIfsAndElses(IfStatement ifStatement) {
def ifs = []
def theElse = null
def node = ifStatement
while (theElse == null) {
ifs.add node
if (node.elseBlock instanceof IfStatement) {
node = node.elseBlock
} else {
theElse = node.elseBlock
}
}
[ifs, theElse]
}
private static isValidElseBlock(Statement elseBlock) {
elseBlock != null && !elseBlock.empty && !(elseBlock instanceof IfStatement)
}
private static allBranchesReturn(Statement expr) {
if(expr instanceof BlockStatement) {
expr.statements.any {
allBranchesReturn(it)
}
} else if (expr instanceof IfStatement) {
allBranchesReturn(expr.ifBlock) && allBranchesReturn(expr.elseBlock)
} else {
isReturn expr
}
}
private static isReturn(statement) {
statement instanceof ReturnStatement
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryInstanceOfCheckRule.groovy 0000644 0001750 0001750 00000004123 12006632020 032654 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.NotExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* This rule finds instanceof checks that cannot possibly evaluate to true. For instance, checking that (!variable instanceof String) will never be true because the result of a not expression is always a boolean.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryInstanceOfCheckRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryInstanceOfCheck'
int priority = 3
Class astVisitorClass = UnnecessaryInstanceOfCheckAstVisitor
}
class UnnecessaryInstanceOfCheckAstVisitor extends AbstractAstVisitor {
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (isFirstVisit(expression)) {
if (AstUtil.isBinaryExpressionType(expression, 'instanceof') && expression.leftExpression instanceof NotExpression) {
if (expression.rightExpression.text == 'Boolean') {
addViolation(expression, "The result of '!($expression.leftExpression.text)' will always be a Boolean")
} else {
addViolation(expression, "The result of '!($expression.leftExpression.text)' will never be a $expression.rightExpression.text")
}
}
super.visitBinaryExpression(expression)
}
}
}
././@LongLink 0000644 0000000 0000000 00000000151 00000000000 011600 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryDefInMethodDeclarationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryDefInMethodDeclarationRule.gr0000644 0001750 0001750 00000011374 12304647570 033273 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.ClassHelper
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* If a method has a visibility modifier or a type declaration, then the def keyword is unneeded.
* For instance 'def private method() {}' is redundant and can be simplified to 'private method() {}'.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryDefInMethodDeclarationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryDefInMethodDeclaration'
int priority = 3
Class astVisitorClass = UnnecessaryDefInMethodDeclarationAstVisitor
}
class UnnecessaryDefInMethodDeclarationAstVisitor extends AbstractAstVisitor {
private static final PATTERNS_OF_DISTRACTING_DECLARATION_PARTS = [
"'", // method name with single quotes, e.g.: def 'some method'() { ... }
'"', // method name with double quotes, e.g.: def "some method"() { ... }
'(', // method with parameters, e.g.: def method(def x) { ... }
]
@Override
protected void visitConstructorOrMethod(MethodNode node, boolean isConstructor) {
String declaration = removeDistractingParts(AstUtil.getDeclaration(node, sourceCode))
if (contains(declaration, 'def') && !declaration.contains('<')) {
if (isConstructor) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded on constructors")
} else if (contains(declaration, 'private')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method is marked private")
} else if (contains(declaration, 'protected')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method is marked protected")
} else if (contains(declaration, 'public')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method is marked public")
} else if (contains(declaration, 'static')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method is marked static")
} else if (contains(declaration, 'final')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method is marked final")
} else if (contains(declaration, 'synchronized')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method is marked synchronized")
} else if (contains(declaration, 'abstract')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method is marked abstract")
} else if (contains(declaration, 'strictfp')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method is marked strictfp")
} else if (contains(declaration, 'Object')) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method returns the Object type")
} else if (node.returnType != ClassHelper.DYNAMIC_TYPE) {
addViolation(node, "Violation in class $currentClassName. The def keyword is unneeded when a method specifies a return type")
}
}
super.visitConstructorOrMethod(node, isConstructor)
}
private static removeDistractingParts(declaration) {
def resultDeclaration = declaration
for (pattern in PATTERNS_OF_DISTRACTING_DECLARATION_PARTS) {
if (resultDeclaration.contains(pattern)) {
resultDeclaration = resultDeclaration[0.. getViolationsForSource(SourceCode sourceCode) {
def result = []
List lines = sourceCode.lines
if (!lines) {
return result
}
int lineNumber = 1
for (String line : lines) {
if (line.trim().endsWith(';') && !line.matches(excludePattern)) {
result.add(
new Violation(
rule: this, lineNumber: lineNumber, sourceLine: line,
message: 'Semi-colons as line endings can be removed safely'
)
)
}
lineNumber++
}
result
}
}
class UnnecessarySemicolonAstVisitor extends AbstractAstVisitor {
@Override
void visitConstantExpression(ConstantExpression node) {
// search inside multiline strings
if (node.value instanceof String && node.lineNumber != node.lastLineNumber) {
removeViolationsInRange(node.lineNumber, node.lastLineNumber - 1)
}
super.visitConstantExpression(node)
}
private removeViolationsInRange(start, end) {
rule.temporaryViolations.get().removeAll { Violation v ->
v.lineNumber >= start && v.lineNumber <= end
}
}
}
././@LongLink 0000644 0000000 0000000 00000000152 00000000000 011601 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryBigIntegerInstantiationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryBigIntegerInstantiationRule.g0000644 0001750 0001750 00000002451 12006632012 033355 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codenarc.rule.AbstractAstVisitorRule
/**
* It is unnecessary to instantiate BigInteger objects. Instead just use the literal with the 'G' identifier to force the type, such as 8G or 42G.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryBigIntegerInstantiationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryBigIntegerInstantiation'
int priority = 3
Class astVisitorClass = UnnecessaryBigIntegerInstantiationAstVisitor
}
class UnnecessaryBigIntegerInstantiationAstVisitor extends UnnecessaryInstantiationAstVisitor {
UnnecessaryBigIntegerInstantiationAstVisitor() {
super(BigInteger, [String], 'G')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryCollectCallRule.groovy 0000644 0001750 0001750 00000011132 12006632014 032047 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.*
/**
* Some method calls to Object.collect(Closure) can be replaced with the spread operator. For instance, list.collect { it.multiply(2) } can be replaced by list*.multiply(2).
*
* @author Hamlet D'Arcy
*/
class UnnecessaryCollectCallRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryCollectCall'
int priority = 3
Class astVisitorClass = UnnecessaryCollectCallAstVisitor
}
class UnnecessaryCollectCallAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodNamed(call, 'collect', 1)) {
def args = AstUtil.getMethodArguments(call)
whenOneStatementClosureFound(args) { exp, parmName ->
if (isPossibleViolation(exp, parmName)) {
addViolationWithMessage(call, exp)
}
}
}
}
private whenOneStatementClosureFound(List args, Closure callback) {
// do we have one closure parameter?
if (args[0] instanceof ClosureExpression && args[0].parameters?.length < 2) {
ClosureExpression c = args[0]
// do we have one statement in the closure?
if (c.code instanceof BlockStatement && c.code.statements?.size() == 1) {
def parmName = 'it'
if (c.parameters?.length == 1) {
parmName = c.parameters[0].name
}
if (c.code.statements[0] instanceof ExpressionStatement) {
def exp = c.code.statements[0].expression
callback(exp, parmName)
}
}
}
}
private static boolean isPossibleViolation(Expression exp, String parmName) {
if (!(exp instanceof MethodCallExpression) && !(exp instanceof PropertyExpression)) {
return false
}
if (!(exp.objectExpression instanceof VariableExpression)) {
return false
}
if (exp.objectExpression.name != parmName) {
return false
}
def finder = new VariableUsageFinder(targetVariable: parmName)
if (exp instanceof MethodCallExpression) {
exp.method.visit finder
exp.arguments.visit finder
} else if (exp instanceof PropertyExpression) {
exp.property.visit finder
}
!finder.found
}
@SuppressWarnings('CatchThrowable')
private addViolationWithMessage(MethodCallExpression call, MethodCallExpression exp) {
try {
addViolation(call, "The call to collect could probably be rewritten as a spread expression: ${call.objectExpression.text}*.${exp.method.text}${exp.arguments.text}")
} catch (Throwable t) {
addViolation(call, 'The call to collect could probably be rewritten as a spread expression. ')
}
}
@SuppressWarnings('CatchThrowable')
private addViolationWithMessage(MethodCallExpression call, PropertyExpression exp) {
try {
addViolation(call, "The call to collect could probably be rewritten as a spread expression: ${call.objectExpression.text}*.${exp.property.text}")
} catch (Throwable t) {
addViolation(call, 'The call to collect could probably be rewritten as a spread expression. ')
}
}
}
class VariableUsageFinder extends AbstractAstVisitor {
String targetVariable
boolean found = false
@Override
void visitVariableExpression(VariableExpression expression) {
if (expression.name == targetVariable) {
found = true
} else {
super.visitVariableExpression expression
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryTransientModifierRule.groovy 0000644 0001750 0001750 00000003251 12311373552 033327 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* The field is marked as transient, but the class isn't Serializable, so marking it as transient should have no effect.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryTransientModifierRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryTransientModifier'
int priority = 3
Class astVisitorClass = UnnecessaryTransientModifierAstVisitor
}
class UnnecessaryTransientModifierAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (Modifier.isTransient(node.modifiers)) {
if (!AstUtil.classNodeImplementsType(node.owner, Serializable)) {
addViolation(node, "The field '$node.name' is marked transient, but $node.owner.name does not implement Serializable")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryToStringRule.groovy 0000644 0001750 0001750 00000005752 12325340351 031456 0 ustar ebourg ebourg /*
* Copyright 2014 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.unnecessary
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.expr.DeclarationExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Checks for unnecessary calls to toString().
*
* Only check for calls to toString() for the value assigned to a String field or variable
* if checkAssignments is true.
*
* @author Chris Mair
*/
class UnnecessaryToStringRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryToString'
int priority = 2
Class astVisitorClass = UnnecessaryToStringAstVisitor
// If true, then check for calls to toString() for the value assigned to a String field or variable.
boolean checkAssignments = true
}
class UnnecessaryToStringAstVisitor extends AbstractAstVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (isFirstVisit(call) && AstUtil.isMethodCall(call, 'toString', 0) && isStringType(call.objectExpression)) {
addViolation(call, "Calling toString() on the String expression in class $currentClassName is unnecessary")
}
super.visitMethodCallExpression(call)
}
@Override
void visitField(FieldNode node) {
if (isStringType(node) && AstUtil.isMethodCall(node.initialExpression, 'toString', 0) && rule.checkAssignments) {
addViolation(node, "Calling toString() when assigning to String field \"${node.name}\" in class $currentClassName is unnecessary")
}
super.visitField(node)
}
@Override
void visitDeclarationExpression(DeclarationExpression expression) {
if (expression.leftExpression instanceof VariableExpression && isStringType(expression.leftExpression)) {
if (AstUtil.isMethodCall(expression.rightExpression, 'toString', 0) && rule.checkAssignments) {
def varName = expression.leftExpression.name
addViolation(expression, "Calling toString() when assigning to String variable \"$varName\" in class $currentClassName is unnecessary")
}
}
super.visitDeclarationExpression(expression)
}
private boolean isStringType(node) {
node.type.name in ['String', 'java.lang.String']
}
}
././@LongLink 0000644 0000000 0000000 00000000146 00000000000 011604 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryInstantiationAstVisitor.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryInstantiationAstVisitor.groov0000644 0001750 0001750 00000005310 12006632012 033520 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.TupleExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.util.AstUtil
/**
* Base visitor for unnecessary constructor calls.
* @author Hamlet D'Arcy
*/
class UnnecessaryInstantiationAstVisitor extends AbstractAstVisitor {
Class targetType
List parameterTypes
String suffix
UnnecessaryInstantiationAstVisitor(Class targetType, List parameterTypes, String suffix) {
this.targetType = targetType
this.parameterTypes = parameterTypes
this.suffix = suffix
}
@SuppressWarnings('UnusedMethodParameter')
protected boolean isTypeSuffixNecessary(argument) {
return true
}
@Override
final void visitConstructorCallExpression(ConstructorCallExpression call) {
if (!isFirstVisit(call)) {
return
}
if (AstUtil.classNodeImplementsType(call.type, targetType)
&& call.arguments instanceof TupleExpression
&& call.arguments.expressions.size() == 1) {
Expression argument = call.arguments.expressions.head()
parameterTypes.each { Class clazz ->
if (argument instanceof ConstantExpression
&& argument.value.getClass() == clazz
&& !shouldSkipViolation(argument.value)) {
boolean isSuffixNecessary = isTypeSuffixNecessary(argument.value)
def replacementOptions = isSuffixNecessary ?
"${argument.value}$suffix" :
"${argument.value} or ${argument.value}$suffix"
addViolation call, "Can be rewritten as $replacementOptions"
}
}
}
super.visitConstructorCallExpression call
}
@SuppressWarnings('UnusedMethodParameter')
protected boolean shouldSkipViolation(Object value) {
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryDotClassRule.groovy 0000644 0001750 0001750 00000004074 12322572174 031424 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* To make a reference to a class, it is unnecessary to specify the '.class' identifier. For instance String.class can be shortened to String.
*
* @author 'Dean Del Ponte'
* @author Chris Mair
*/
class UnnecessaryDotClassRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryDotClass'
int priority = 3
Class astVisitorClass = UnnecessaryDotClassAstVisitor
}
class UnnecessaryDotClassAstVisitor extends AbstractAstVisitor {
@Override
void visitPropertyExpression(PropertyExpression expression) {
if (isFirstVisit(expression) && AstUtil.isConstant(expression.property, 'class')) {
def object = expression.objectExpression
boolean isClassPropertyExpression = object instanceof PropertyExpression &&
object.property instanceof ConstantExpression &&
Character.isUpperCase(object.property.value.toCharacter())
if (isClassPropertyExpression || AstUtil.isVariable(object, /[A-Z].*/)) {
def exprText = object.text
addViolation(expression, "${exprText}.class can be rewritten as $exprText")
}
}
super.visitPropertyExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryPublicModifierRule.groovy 0000644 0001750 0001750 00000005727 12006632014 032600 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.apache.log4j.Logger
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.ConstructorNode
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* The 'public' modifier is not required on methods, constructors or classes.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryPublicModifierRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryPublicModifier'
int priority = 3
Class astVisitorClass = UnnecessaryPublicModifierAstVisitor
}
class UnnecessaryPublicModifierAstVisitor extends AbstractAstVisitor {
private static final LOG = Logger.getLogger(UnnecessaryPublicModifierAstVisitor)
@Override
protected void visitClassEx(ClassNode node) {
if (!node.isScript()) {
checkDeclaration(node, 'classes')
}
super.visitClassEx(node)
}
@Override
void visitMethodEx(MethodNode node) {
checkDeclaration(node, 'methods')
super.visitMethodEx(node)
}
@Override
void visitConstructor(ConstructorNode node) {
checkDeclaration(node, 'constructors')
super.visitConstructor(node)
}
private void checkDeclaration(node, String nodeType) {
String declaration = getDeclaration(node)
if (getDeclaration(node)?.startsWith('public ')) {
addViolation(node, "The public keyword is unnecessary for $nodeType")
}
else if (declaration?.contains(' public ')) {
addViolation(node, "The public keyword is unnecessary for $nodeType")
}
}
private String getDeclaration(ASTNode node) {
if (node.lineNumber < 0) {
return ''
}
def current = node.lineNumber - 1
String acc = ''
while (current <= node.lastLineNumber) {
def line = sourceCode.line(current)
if (line == null) {
LOG.warn("${rule.name} cannot find source code line $current in ${sourceCode.name}. Scanning lines ${node.lineNumber} to ${node.lastLineNumber}.")
return ''
} else if (line.contains('{')) {
return acc + line[0..(line.indexOf('{'))]
}
acc = acc + line + ' '
current++
}
acc
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryFloatInstantiationRule.groovy0000644 0001750 0001750 00000002441 12006632016 033505 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codenarc.rule.AbstractAstVisitorRule
/**
* It is unnecessary to instantiate Float objects. Instead just use the float literal with the 'F' identifier to force the type, such as 123.45F or 0.42f.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryFloatInstantiationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryFloatInstantiation'
int priority = 3
Class astVisitorClass = UnnecessaryFloatInstantiationAstVisitor
}
class UnnecessaryFloatInstantiationAstVisitor extends UnnecessaryInstantiationAstVisitor {
UnnecessaryFloatInstantiationAstVisitor() {
super(Float, [String, Double, Float], 'f')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessarySelfAssignmentRule.groovy 0000644 0001750 0001750 00000006025 12006632014 032615 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Method contains a pointless self-assignment to a variable or property.
*
* @author Hamlet D'Arcy
*/
class UnnecessarySelfAssignmentRule extends AbstractAstVisitorRule {
String name = 'UnnecessarySelfAssignment'
int priority = 3
Class astVisitorClass = UnnecessarySelfAssignmentAstVisitor
}
class UnnecessarySelfAssignmentAstVisitor extends AbstractAstVisitor {
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (AstUtil.isBinaryExpressionType(expression, '=')) {
Expression left = expression.leftExpression
Expression right = expression.rightExpression
if (left instanceof VariableExpression && right instanceof VariableExpression) {
if (left.name == right.name) {
addViolation(expression, 'Assignment a variable to itself should be unnecessary. Remove this dead code')
}
} else if (propertyExpressionsAreEqual(left, right)) {
if (left.text == right.text) {
addViolation(expression, 'Assignment a variable to itself should be unnecessary. Remove this dead code')
}
}
}
super.visitBinaryExpression(expression)
}
private static boolean propertyExpressionsAreEqual(Expression left, Expression right) {
def stack = [[left, right]] as Stack
while (stack) {
(left, right) = stack.pop()
if (!(left instanceof PropertyExpression) || !(right instanceof PropertyExpression)) {
return false
}
if (left.text != right.text) {
return false
}
if (left.spreadSafe != right.spreadSafe || left.safe != right.safe) {
return false
}
if (left.objectExpression instanceof PropertyExpression && right.objectExpression instanceof PropertyExpression) {
// recursive alternative
stack << [left.objectExpression, right.objectExpression]
}
}
true
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryCastRule.groovy 0000644 0001750 0001750 00000003632 12462042133 030571 0 ustar ebourg ebourg /*
* Copyright 2014 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.unnecessary
import org.codehaus.groovy.ast.expr.CastExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
/**
* Checks for unnecessary cast operations
*
* @author Chris Mair
*/
class UnnecessaryCastRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryCast'
int priority = 2
Class astVisitorClass = UnnecessaryCastAstVisitor
}
class UnnecessaryCastAstVisitor extends AbstractAstVisitor {
// Map of Cast type -> Cast expression type (both as Strings)
private static final CAST_TYPE_MAP = [
int:'java.lang.Integer',
long:'java.lang.Long',
BigDecimal:'java.math.BigDecimal',
String:'java.lang.String',
List:'java.util.List',
Map:'java.util.Map',
]
@Override
void visitCastExpression(CastExpression expression) {
if (isUnnecessaryCast(expression)) {
addViolation(expression, "The cast ${expression.text} in class $currentClassName is unnecessary")
}
super.visitCastExpression(expression)
}
private boolean isUnnecessaryCast(CastExpression expression) {
CAST_TYPE_MAP[expression.type.name] == expression.expression.type.name ||
expression.type.name == expression.expression.type.name
}
}
././@LongLink 0000644 0000000 0000000 00000000166 00000000000 011606 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryParenthesesForMethodCallWithClosureRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryParenthesesForMethodCallWithC0000644 0001750 0001750 00000004332 12006632012 033340 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
import org.codenarc.util.SourceCodeUtil
/**
* If a method is called and the only parameter to that method is an inline closure then the brackets of the method call can be omitted.
*
* @author Marcin Erdmann
*/
class UnnecessaryParenthesesForMethodCallWithClosureRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryParenthesesForMethodCallWithClosure'
int priority = 3
Class astVisitorClass = UnnecessaryParenthesesForMethodCallWithClosureAstVisitor
}
class UnnecessaryParenthesesForMethodCallWithClosureAstVisitor extends AbstractMethodCallExpressionVisitor {
private final static EMPTY_BRACKETS_PATTERN = /\s*\(\s*\)\s*/
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (!AstUtil.isFromGeneratedSourceCode(call.method)) {
def arguments = AstUtil.getMethodArguments(call)
if (arguments.size() == 1 && arguments.first() instanceof ClosureExpression) {
def sourceBetweenMethodAndClosure = SourceCodeUtil.sourceLinesBetweenNodes(sourceCode, call.method, arguments.first()).join()
if (sourceBetweenMethodAndClosure ==~ EMPTY_BRACKETS_PATTERN) {
addViolation(call, "Parentheses in the '$call.methodAsString' method call are unnecessary and can be removed.")
}
}
}
}
}
././@LongLink 0000644 0000000 0000000 00000000147 00000000000 011605 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryBooleanInstantiationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryBooleanInstantiationRule.groo0000644 0001750 0001750 00000004734 12311373552 033455 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractConstructorCallAstVisitor
import org.codenarc.util.AstUtil
/**
* Rule that checks for direct call to Boolean constructor - use Boolean.valueOf() instead.
* Also checks for Boolean.valueOf(true) or Boolean.valueOf(false) - use Boolean.TRUE or
* Boolean.FALSE instead.
*
* @author Chris Mair
*/
class UnnecessaryBooleanInstantiationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryBooleanInstantiation'
int priority = 3
Class astVisitorClass = UnnecessaryBooleanInstantiationAstVisitor
}
class UnnecessaryBooleanInstantiationAstVisitor extends AbstractConstructorCallAstVisitor {
static final NEW_BOOLEAN = /new +(java\.lang\.)?Boolean\(/
protected isConstructorCallAViolation(ConstructorCallExpression constructorCall) {
constructorCall.text =~ NEW_BOOLEAN
}
void visitMethodCallExpression(MethodCallExpression methodCall) {
if (isFirstVisit(methodCall)) {
def args = AstUtil.getMethodArguments(methodCall)
def isMatch = AstUtil.isMethodCall(methodCall, 'Boolean', 'valueOf', 1) &&
args[0] instanceof ConstantExpression && args[0].value in [true, false]
if (isMatch) {
addViolation(methodCall,
"Call to $methodCall.text is unnecessary and can probably be replaced with simply ${args[0].value}")
}
}
super.visitMethodCallExpression(methodCall)
}
@Override
protected String getViolationMessage(ConstructorCallExpression call) {
'There is typically no need to instantiate Boolean instances.'
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryCollectionCallRule.groovy 0000644 0001750 0001750 00000003725 12006632014 032566 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.TupleExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
/**
* Useless call to collections. This call doesn't make sense. For any collection c, calling c.containsAll(c) should
* always be true, and c.retainAll(c) should have no effect.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryCollectionCallRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryCollectionCall'
int priority = 3
Class astVisitorClass = UnnecessaryCollectionCallAstVisitor
}
class UnnecessaryCollectionCallAstVisitor extends AbstractMethodCallExpressionVisitor {
private static final List USELESS_METHOD_NAMES = ['retainAll', 'containsAll']
void visitMethodCallExpression(MethodCallExpression call) {
if (USELESS_METHOD_NAMES.contains(call.method.text)) {
String variableName = call.objectExpression.text
if (call.arguments instanceof TupleExpression && call.arguments.expressions.size() == 1) {
def argName = call.arguments.expressions[0].text
if (argName == variableName) {
addViolation call, "The call to $call.method.text has no effect"
}
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryCallToSubstringRule.groovy 0000644 0001750 0001750 00000003254 12006632012 032751 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* Calling String.substring(0) always returns the original string. This code is meaningless.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryCallToSubstringRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryCallToSubstring'
int priority = 3
Class astVisitorClass = UnnecessaryCallToSubstringAstVisitor
}
class UnnecessaryCallToSubstringAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodNamed(call, 'substring', 1)) {
def arg = AstUtil.getMethodArguments(call)[0]
if (AstUtil.isConstant(arg, 0)) {
addViolation(call, 'Invoking the String method substring(0) always returns the original value. Method possibly missing 2nd parameter')
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryObjectReferencesRule.groovy 0000644 0001750 0001750 00000006371 12006632014 033107 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codehaus.groovy.ast.stmt.Statement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Violations are triggered when an excessive set of consecutive statements all reference the same variable. This can be made more readable by using a with or identity block.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryObjectReferencesRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryObjectReferences'
int priority = 3
int maxReferencesAllowed = 5
Class astVisitorClass = UnnecessaryObjectReferencesAstVisitor
}
class UnnecessaryObjectReferencesAstVisitor extends AbstractAstVisitor {
private final runCollector = [variable: null, count: 0, clear: { this.variable = null; this.count = 0 }]
@Override
void visitBlockStatement(BlockStatement block) {
// search for runs of methods or runs of properties
block.statements.each { Statement statement ->
if (!(statement instanceof ExpressionStatement)) {
runCollector.clear()
return
}
def exp = statement.expression
if (exp instanceof MethodCallExpression && exp.objectExpression instanceof VariableExpression) {
accumulateOrError(exp.objectExpression.variable, statement)
} else if (exp instanceof BinaryExpression && exp.leftExpression instanceof PropertyExpression
&& exp.leftExpression.objectExpression instanceof VariableExpression ) {
accumulateOrError(exp.leftExpression.objectExpression.variable, statement)
} else {
runCollector.clear()
}
}
runCollector.clear()
super.visitBlockStatement block
}
private void accumulateOrError(String variable, ExpressionStatement statement) {
if (variable == runCollector.variable) {
if (runCollector.count == rule.maxReferencesAllowed) {
addViolation statement.expression, 'The code could be more concise by using a with() or identity() block'
} else {
runCollector.count = runCollector.count + 1
}
} else if (variable != 'this') {
runCollector.variable = variable
runCollector.count = 1
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryIfStatementRule.groovy 0000644 0001750 0001750 00000017515 12311373553 032135 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.stmt.*
/**
* Rule that checks for unnecessary if statements. If/else statements are considered unnecessary for
* the four scenarios described below.
*
* (1) When the if and else blocks contain only an explicit return of true and false
* constants. These cases can be replaced by a simple return statement. Examples include:
*
*
if (someExpression) return true else return false - can be replaced by return someExpression
*
if (someExpression) { return true } else { return false } - can be replaced by return someExpression
*
if (someExpression) { return Boolean.TRUE } else { return Boolean.FALSE } - can be replaced by return someExpression
*
*
* (2) When the if statement is the last statement in a block and the if and else blocks contain only
* true and false expressions. This is an implicit return of true/false.
* For example, the if statement in the following code can be replaced by someExpression:
*
* boolean myMethod() {
* doSomething()
* if (someExpression) true; else false
* }
*
*
* (3) When the second-to-last statement in a block is an if statement with no else, where the block contains a single
* return statement, and the last statement in the block is a return statement, and one return statement returns a
* true expression and the other returns a false expression.
* For example, the if statement in the following code can be replaced by return expression1:
*
* if (expression1) {
* return true
* }
* return false
*
*
* NOTE: This check is disabled by setting checkLastStatementImplicitElse to false.
*
* (4) When either the if block or else block of an if statement that is not the last statement in a
* block contain only a single constant or literal expression
* For example, the if statement in the following code has no effect and can be removed:
*
* def myMethod() {
* if (someExpression) { 123 }
* doSomething()
* }
*
*
* @author Chris Mair
*/
class UnnecessaryIfStatementRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryIfStatement'
int priority = 3
Class astVisitorClass = UnnecessaryIfStatementAstVisitor
boolean checkLastStatementImplicitElse = true
}
class UnnecessaryIfStatementAstVisitor extends AbstractAstVisitor {
@Override
void visitIfElse(IfStatement ifStatement) {
if (isFirstVisit(ifStatement) && hasElseBlock(ifStatement)) {
if (areReturningTrueAndFalse(ifStatement.ifBlock, ifStatement.elseBlock)) {
addViolation(ifStatement, 'The if and else blocks merely return true/false')
}
}
super.visitIfElse(ifStatement)
}
@Override
void visitBlockStatement(BlockStatement block) {
def allStatements = block.statements
def allExceptLastStatement = allExceptLastElement(allStatements)
allExceptLastStatement.each { statement ->
if (statement instanceof IfStatement) {
visitIfElseThatIsNotTheLastStatementInABlock(statement)
}
}
if (allStatements && allStatements.last() instanceof IfStatement) {
visitIfElseThatIsTheLastStatementInABlock(allStatements.last())
}
if (allStatements.size() > 1 && rule.checkLastStatementImplicitElse) {
def nextToLastStatement = allStatements[-2]
if (nextToLastStatement instanceof IfStatement && hasNoElseBlock(nextToLastStatement)) {
def lastStatement = allStatements[-1]
if (areReturningTrueAndFalse(nextToLastStatement.ifBlock, lastStatement)) {
addViolation(nextToLastStatement, 'The if block and the subsequent fall-through statement merely return true/false')
}
}
}
super.visitBlockStatement(block)
}
private void visitIfElseThatIsNotTheLastStatementInABlock(IfStatement ifStatement) {
if (isOnlyAConstantOrLiteralExpression(ifStatement.ifBlock)) {
addViolation(ifStatement, 'The if block is a constant or literal')
}
if (isOnlyAConstantOrLiteralExpression(ifStatement.elseBlock)) {
addViolation(ifStatement.elseBlock, 'The else block is a constant or literal')
}
}
private void visitIfElseThatIsTheLastStatementInABlock(IfStatement ifStatement) {
if (isFirstVisit([CHECK_FOR_CONSTANT:ifStatement]) && hasElseBlock(ifStatement)) {
if (areTrueAndFalseExpressions(ifStatement.ifBlock, ifStatement.elseBlock)) {
addViolation(ifStatement, 'The if and else blocks implicitly return true/false')
}
}
}
private boolean areReturningTrueAndFalse(Statement ifBlock, Statement elseBlock) {
(isReturnTrue(ifBlock) && isReturnFalse(elseBlock)) ||
(isReturnFalse(ifBlock) && isReturnTrue(elseBlock))
}
private boolean isReturnTrue(Statement blockStatement) {
def statement = getStatement(blockStatement)
statement instanceof ReturnStatement && AstUtil.isTrue(statement.expression)
}
private boolean isReturnFalse(Statement blockStatement) {
def statement = getStatement(blockStatement)
statement instanceof ReturnStatement && AstUtil.isFalse(statement.expression)
}
private boolean areTrueAndFalseExpressions(Statement ifBlock, Statement elseBlock) {
(isTrueExpression(ifBlock) && isFalseExpression(elseBlock)) ||
(isFalseExpression(ifBlock) && isTrueExpression(elseBlock))
}
private boolean isTrueExpression(Statement blockStatement) {
def statement = getStatement(blockStatement)
statement instanceof ExpressionStatement && AstUtil.isTrue(statement.expression)
}
private boolean isFalseExpression(Statement blockStatement) {
def statement = getStatement(blockStatement)
statement instanceof ExpressionStatement && AstUtil.isFalse(statement.expression)
}
private boolean hasElseBlock(IfStatement ifStatement) {
!ifStatement.elseBlock.empty
}
private boolean hasNoElseBlock(IfStatement ifStatement) {
ifStatement.elseBlock.empty
}
private boolean isOnlyAConstantOrLiteralExpression(Statement blockStatement) {
def statement = getStatement(blockStatement)
statement instanceof ExpressionStatement && AstUtil.isConstantOrLiteral(statement.expression)
}
private Statement getStatement(Statement statement) {
isSingleStatementBlock(statement) ? statement.statements.get(0) : statement
}
private boolean isSingleStatementBlock(Statement statement) {
statement instanceof BlockStatement && statement.statements.size() == 1
}
private allExceptLastElement(list) {
def lastElement = list.empty ? null : list.last()
list - lastElement
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/ConsecutiveLiteralAppendsRule.groovy 0000644 0001750 0001750 00000005112 12311370173 032572 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.GStringExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
import org.codenarc.util.ConsecutiveUtils
/**
* Violations occur when method calls to append(Object) are chained together with literals as parameters. The chained calls can be joined into one invocation.
*
* @author 'Hamlet D'Arcy'
*/
class ConsecutiveLiteralAppendsRule extends AbstractAstVisitorRule {
String name = 'ConsecutiveLiteralAppends'
int priority = 2
Class astVisitorClass = ConsecutiveLiteralAppendsAstVisitor
}
class ConsecutiveLiteralAppendsAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (isChainedAppend(call)) {
def arg1 = AstUtil.getMethodArguments(call.objectExpression)[0]
def arg2 = AstUtil.getMethodArguments(call)[0]
if (ConsecutiveUtils.areJoinableConstants(arg1, arg2) && !AstUtil.isNull(arg1) && !AstUtil.isNull(arg2)) {
if (arg1 instanceof GStringExpression || arg2 instanceof GStringExpression) {
addViolation(call, 'Consecutive calls to append method with literal parameters can be joined into one append() call')
} else {
addViolation(call, "Consecutive calls to append method with literal parameters can be joined into append('${arg1.value}${arg2.value}')")
}
}
}
}
static private boolean isChainedAppend(MethodCallExpression call) {
if (AstUtil.isMethodNamed(call, 'append', 1)) {
if (call.objectExpression instanceof MethodCallExpression
&& AstUtil.isMethodNamed(call.objectExpression, 'append', 1)) {
return true
}
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryBooleanExpressionRule.groovy 0000644 0001750 0001750 00000006327 12311373552 033347 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.NotExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks unnecessary boolean expressions, including ANDing (&&) or ORing (||) with
* true, false, null, or a Map/List/String/Number literal.
*
* This rule also checks for negation (!) of true, false,
* null, or a Map/List/String/Number literal.
* Examples include:
*
*
def result = value && true
*
if (false || value) { .. }
*
return value && Boolean.FALSE
*
result = value && "abc"
*
result = null && value
*
result = value && 123
*
result = 678.123 || true
*
result = value && [x, y]
*
def result = [a:123] && value
*
*
result = !true
*
result = !false
*
result = !Boolean.TRUE
*
result = !null
*
result = !"abc"
*
result = ![a:123]
*
result = ![a,b]
*
*
* @author Chris Mair
*/
class UnnecessaryBooleanExpressionRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryBooleanExpression'
int priority = 3
Class astVisitorClass = UnnecessaryBooleanExpressionAstVisitor
}
class UnnecessaryBooleanExpressionAstVisitor extends AbstractAstVisitor {
private static final BOOLEAN_LOGIC_OPERATIONS = ['&&', '||']
void visitBinaryExpression(BinaryExpression expression) {
def operationName = expression.operation.text
if (operationName in BOOLEAN_LOGIC_OPERATIONS &&
(AstUtil.isConstantOrLiteral(expression.rightExpression) ||
AstUtil.isConstantOrLiteral(expression.leftExpression))) {
addViolation(expression, "The expression using $operationName is compared to a constant")
}
super.visitBinaryExpression(expression)
}
void visitNotExpression(NotExpression expression) {
if (AstUtil.isConstantOrLiteral(expression.expression)) {
addViolation(expression, 'The Not expression contains a literal or contant. ')
}
super.visitNotExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryConstructorRule.groovy 0000644 0001750 0001750 00000005124 12041061502 032214 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.ConstructorNode
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* UnnecessaryConstructor
*
* @author Tomasz Bujok
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class UnnecessaryConstructorRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryConstructor'
int priority = 3
Class astVisitorClass = UnnecessaryConstructorAstVisitor
}
class UnnecessaryConstructorAstVisitor extends AbstractAstVisitor {
void visitClassEx(ClassNode node) {
if (node.declaredConstructors?.size() == 1) {
analyzeConstructor node.declaredConstructors[0]
}
super.visitClassEx(node)
}
private void analyzeConstructor(ConstructorNode node) {
if(isEmptyOrJustCallsSuper(node) && !Modifier.isPrivate(node.modifiers) && node.parameters?.size() == 0) {
addViolation node, 'The constructor can be safely deleted'
}
}
private boolean isEmptyOrJustCallsSuper(ConstructorNode node) {
isEmptyConstructor(node) || containsOnlyCallToSuper(node)
}
private boolean isEmptyConstructor(ConstructorNode node) {
node.code?.isEmpty()
}
private boolean containsOnlyCallToSuper(ConstructorNode node) {
if (!AstUtil.isOneLiner(node.code)) {
return false
}
def onlyStatement = node.code.statements[0]
return onlyStatement instanceof ExpressionStatement &&
onlyStatement.expression instanceof ConstructorCallExpression &&
onlyStatement.expression.superCall &&
onlyStatement.expression.arguments.expressions.empty
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryCallForLastElementRule.groovy0000644 0001750 0001750 00000007605 12311370173 033364 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.*
/**
* This rule checks for excessively verbose methods of accessing the last element of an array or list. For instance,
* it is possible to access the last element of an array by performing array[array.length - 1], in Groovy it is
* simpler to either call array.last() or array[-1]. The same is true for lists. This violation is triggered whenever a
* get, getAt, or array-style access is used with an object size check.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryCallForLastElementRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryCallForLastElement'
int priority = 3
Class astVisitorClass = UnnecessaryCallForLastElementAstVisitor
}
class UnnecessaryCallForLastElementAstVisitor extends AbstractAstVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodNamed(call, 'get', 1) || AstUtil.isMethodNamed(call, 'getAt', 1)) {
def methodObjectText = call.objectExpression.text
if (call.arguments instanceof ArgumentListExpression) {
Expression exp = call.arguments?.expressions?.first()
if (isSubtractOneOnObject(methodObjectText, exp)) {
addViolation call,
"Unnecessarily complex access of last element. This can be simplified to ${methodObjectText}.last() or ${methodObjectText}[-1]"
}
}
}
super.visitMethodCallExpression call
}
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (expression.operation.getText() == '[') {
def methodObjectText = expression.leftExpression.text
if (isSubtractOneOnObject(methodObjectText, expression.rightExpression)) {
addViolation expression,
"Unnecessarily complex access of last element. This can be simplified to ${methodObjectText}.last() or ${methodObjectText}[-1]"
}
}
super.visitBinaryExpression expression
}
private static isSubtractOneOnObject(String methodObjectText, Expression exp) {
if (!(exp instanceof BinaryExpression)) {
return false
}
if (exp.operation.text != '-') {
return false
}
if (!(exp.rightExpression instanceof ConstantExpression)) {
return false
}
if (exp.rightExpression.value != 1) {
return false
}
if (exp.leftExpression instanceof MethodCallExpression) {
if (AstUtil.isMethodCall(exp.leftExpression, methodObjectText, 'size', 0)) {
return true
}
}
if (exp.leftExpression instanceof PropertyExpression) {
PropertyExpression property = exp.leftExpression
if (property.objectExpression.text != methodObjectText) {
return false
}
if (!(property.property instanceof ConstantExpression)) {
return false
}
if (property.property.value == 'length') {
return true
}
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryNullCheckRule.groovy 0000644 0001750 0001750 00000013613 12006632016 031546 0 ustar ebourg ebourg /*
* Copyright 2011 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.unnecessary
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.*
/**
* Groovy contains the safe dereference operator, which can be used in boolean conditional statements to safely
* replace explicit "x == null" tests.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryNullCheckRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryNullCheck'
int priority = 3
Class astVisitorClass = UnnecessaryNullCheckAstVisitor
}
class UnnecessaryNullCheckAstVisitor extends AbstractAstVisitor {
@SuppressWarnings('NestedBlockDepth')
@Override
void visitBooleanExpression(BooleanExpression expression) {
if (isFirstVisit(expression)) {
def exp = expression.expression
if (exp instanceof BinaryExpression && exp.operation.text == '&&') {
if (AstUtil.isNotNullCheck(exp.leftExpression)) {
// perform should use null-safe dereference test
def nullTarget = AstUtil.getNullComparisonTarget(exp.leftExpression)
if (isPropertyInvocation(exp.rightExpression, nullTarget)) {
def suggestion = "$nullTarget?.$exp.rightExpression.property.text"
addViolation(expression, "The expression $expression.text can be simplified to ($suggestion)")
} else if (isMethodInvocation(exp.rightExpression, nullTarget)) {
def suggestion = "$nullTarget?.${exp.rightExpression.method.text}${exp.rightExpression.arguments.text}"
addViolation(expression, "The expression $expression.text can be simplified to ($suggestion)")
}
} else if (AstUtil.isNotNullCheck(exp.rightExpression)) {
def nullTarget = AstUtil.getNullComparisonTarget(exp.rightExpression)
// perform pointless null check test
if (isPropertyInvocation(exp.leftExpression, nullTarget) || isMethodInvocation(exp.leftExpression, nullTarget)) {
def suggestion = exp.leftExpression.text
addViolation(expression, "The expression $expression.text can be simplified to ($suggestion)")
}
}
} else if (isNotNullCheckAgainstThisReference(exp)) {
addViolation(expression, 'Testing the this reference for not null will always return true')
} else if (isNullCheckAgainstThisReference(exp)) {
addViolation(expression, 'Testing the this reference for null will always return false')
} else if (isNotNullCheckAgainstSuperReference(exp)) {
addViolation(expression, 'Testing the super reference for not null will always return true')
} else if (isNullCheckAgainstSuperReference(exp)) {
addViolation(expression, 'Testing the super reference for null will always return false')
}
super.visitBooleanExpression(expression)
}
}
private static boolean isSuperReference(Expression expression) {
expression instanceof VariableExpression && expression.variable == 'super'
}
private static boolean isNotNullCheckAgainstThisReference(Expression exp) {
if (exp instanceof BinaryExpression && AstUtil.isNotNullCheck(exp)) {
if (AstUtil.isThisReference(exp.leftExpression) || AstUtil.isThisReference(exp.rightExpression)) {
return true
}
}
false
}
private static boolean isNotNullCheckAgainstSuperReference(Expression exp) {
if (exp instanceof BinaryExpression && AstUtil.isNotNullCheck(exp)) {
if (isSuperReference(exp.leftExpression) || isSuperReference(exp.rightExpression)) {
return true
}
}
false
}
private static boolean isNullCheckAgainstThisReference(Expression exp) {
if (exp instanceof BinaryExpression && AstUtil.isNullCheck(exp)) {
if (AstUtil.isThisReference(exp.leftExpression) || AstUtil.isThisReference(exp.rightExpression)) {
return true
}
}
false
}
private static boolean isNullCheckAgainstSuperReference(Expression exp) {
if (exp instanceof BinaryExpression && AstUtil.isNullCheck(exp)) {
if (isSuperReference(exp.leftExpression) || isSuperReference(exp.rightExpression)) {
return true
}
}
false
}
private static boolean isPropertyInvocation(expression, String targetName) {
if (expression instanceof PropertyExpression) {
if (expression.objectExpression instanceof VariableExpression) {
if (expression.objectExpression.variable == targetName) {
return true
}
}
}
false
}
private static boolean isMethodInvocation(expression, String targetName) {
if (expression instanceof MethodCallExpression) {
if (expression.objectExpression instanceof VariableExpression) {
if (expression.objectExpression.variable == targetName) {
return true
}
}
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryCatchBlockRule.groovy 0000644 0001750 0001750 00000004630 12311370173 031674 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.CatchStatement
import org.codehaus.groovy.ast.stmt.ThrowStatement
import org.codehaus.groovy.ast.stmt.TryCatchStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Violations are triggered when a catch block does nothing but throw the original exception. In this scenario there is
* usually no need for a catch block, just let the exception be thrown from the original code. This condition frequently
* occurs when catching an exception for debugging purposes but then forgetting to take the catch statement out.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryCatchBlockRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryCatchBlock'
int priority = 3
Class astVisitorClass = UnnecessaryCatchBlockAstVisitor
}
class UnnecessaryCatchBlockAstVisitor extends AbstractAstVisitor {
@Override
void visitTryCatchFinally(TryCatchStatement statement) {
def badNodes = statement.catchStatements?.findAll { CatchStatement it ->
def paramName = it.variable.name
if (it.code instanceof BlockStatement && it.code.statements.size() == 1) {
def throwStatement = it.code.statements[0]
if (throwStatement instanceof ThrowStatement && AstUtil.isVariable(throwStatement.expression, paramName)) {
return true
}
}
false
}
if (badNodes.size() == statement.catchStatements?.size()) {
badNodes.each {
addViolation it, 'Catch statement can probably be removed.'
}
}
super.visitTryCatchFinally statement
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryLongInstantiationRule.groovy 0000644 0001750 0001750 00000002404 12006632014 033334 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codenarc.rule.AbstractAstVisitorRule
/**
* It is unnecessary to instantiate Long objects. Instead just use the literal with the 'L' identifier to force the type, such as 8L or 42L.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryLongInstantiationRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryLongInstantiation'
int priority = 3
Class astVisitorClass = UnnecessaryLongInstantiationAstVisitor
}
class UnnecessaryLongInstantiationAstVisitor extends UnnecessaryInstantiationAstVisitor {
UnnecessaryLongInstantiationAstVisitor() {
super(Long, [String, Long], 'L')
}
}
././@LongLink 0000644 0000000 0000000 00000000152 00000000000 011601 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryInstantiationToGetClassRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unnecessary/UnnecessaryInstantiationToGetClassRule.g0000644 0001750 0001750 00000003430 12006632014 033346 0 ustar ebourg ebourg /*
* 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.unnecessary
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* Avoid instantiating an object just to call getClass() on it; use the .class public member instead.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryInstantiationToGetClassRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryInstantiationToGetClass'
int priority = 3
Class astVisitorClass = UnnecessaryInstantiationToGetClassAstVisitor
}
class UnnecessaryInstantiationToGetClassAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodNamed(call, 'getClass', 0)) {
if (call.objectExpression instanceof ConstructorCallExpression) {
def typeName = call.objectExpression.type.name
addViolation(call, "$typeName instantiation with getClass() should be simplified to ${typeName}.class")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/ 0000755 0001750 0001750 00000000000 12623571301 023172 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/BracesForForLoopRule.groovy 0000644 0001750 0001750 00000003636 12052041522 030441 0 ustar ebourg ebourg /*
* Copyright 2011 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.formatting
import org.codehaus.groovy.ast.stmt.ForStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Checks the location of the opening brace ({) for for loops. By default, requires them on the same line,
* but the sameLine property can be set to false to override this.
*
* @author Hamlet D'Arcy
*/
class BracesForForLoopRule extends AbstractAstVisitorRule {
String name = 'BracesForForLoop'
int priority = 2
boolean sameLine = true
Class astVisitorClass = BracesForForLoopAstVisitor
}
class BracesForForLoopAstVisitor extends AbstractAstVisitor {
@Override
void visitForLoop(ForStatement node) {
if (AstUtil.isBlock(node.loopBlock)) {
if (rule.sameLine) {
if(!lastSourceLineTrimmed(node.collectionExpression)?.contains('{')) {
addViolation(node, 'Braces should start on the same line')
}
} else {
if(lastSourceLineTrimmed(node.collectionExpression)?.contains('{')) {
addViolation(node, 'Braces should start on a new line')
}
}
}
super.visitForLoop(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/LineLengthRule.groovy 0000644 0001750 0001750 00000005313 12311373552 027326 0 ustar ebourg ebourg /*
* Copyright 2011 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.formatting
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.source.SourceCode
/**
* Checks the maximum length for each line of source code. It checks for number of characters, so lines that include
* tabs may appear longer than the allowed number when viewing the file. The maximum line length can be configured by
* setting the length property, which defaults to 120.
*
* @author Hamlet D'Arcy
* @author Geli Crick
*/
class LineLengthRule extends AbstractAstVisitorRule {
String name = 'LineLength'
int priority = 2
int length = 120 // The default max line length. Can be overridden
boolean ignoreImportStatements = true // import statements can be longer than the max line legnth
boolean ignorePackageStatements = true // import statements can be longer than the max line legnth
@Override
void applyTo(SourceCode sourceCode, List violations) {
int lineNumber = 0
for (line in sourceCode.getLines()) {
lineNumber++
if (sourceViolatesLineLengthRule(line)) {
violations << createViolation(lineNumber, line, "The line exceeds $length characters. The line is ${line.length()} characters.")
}
}
}
private Boolean sourceViolatesLineLengthRule(String line) {
lineExceedsMaxLength(line) && (flagIfImport(line) || flagIfPackage(line) || flagIfRegularLine(line))
}
private Boolean flagIfImport(String line) {
(sourceLineIsImport(line) && !ignoreImportStatements)
}
private Boolean flagIfPackage(String line) {
(sourceLineIsPackage(line) && !ignorePackageStatements)
}
private Boolean flagIfRegularLine(String line) {
!sourceLineIsImport(line) && !sourceLineIsPackage(line)
}
private Boolean sourceLineIsImport(String line) {
line.trim().startsWith('import ')
}
private Boolean sourceLineIsPackage(String line) {
line.trim().startsWith('package ')
}
private Boolean lineExceedsMaxLength(String line) {
line.length() > length
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/ClassJavadocRule.groovy 0000644 0001750 0001750 00000005172 12311373552 027635 0 ustar ebourg ebourg /*
* Copyright 2011 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.formatting
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Makes sure each class and interface definition is preceded by javadoc. Enum definitions are not checked,
* due to strange behavior in the Groovy AST.
*
* @author Hamlet D'Arcy
* @author Geli Crick
*/
class ClassJavadocRule extends AbstractRule {
String name = 'ClassJavadoc'
int priority = 2
boolean applyToNonMainClasses = false
/**
* Apply the rule to the given source, writing violations to the given list.
* @param sourceCode The source to check
* @param violations A list of Violations that may be added to. It can be an empty list
*/
@Override
@SuppressWarnings('EmptyWhileStatement')
void applyTo(SourceCode sourceCode, List violations) {
def lines = sourceCode.getLines()
sourceCode.ast?.classes?.each { classNode ->
if (!applyToNonMainClasses && sourceCodeNameWithoutExtension(sourceCode) != classNode.nameWithoutPackage) {
return // only apply to classes that have same name as the source unit.
}
if (classNode.isPrimaryClassNode() && classNode.superClass.name != 'java.lang.Enum') {
def index = classNode.lineNumber - 1
while (lines[--index].trim().startsWith('*') || lines[index].trim().isEmpty()) {
/* Do nothing, to simulate an until loop */
}
if (!lines[index].trim().startsWith('/**')) {
violations.add(createViolation(sourceCode, classNode, "Class $classNode.name missing JavaDoc"))
}
}
}
}
protected String sourceCodeNameWithoutExtension(SourceCode sourceCode) {
def indexOfPeriod = sourceCode.name?.lastIndexOf('.')
if (indexOfPeriod && indexOfPeriod != -1) {
return sourceCode.name[0..indexOfPeriod - 1]
}
return sourceCode.getName()
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceBeforeClosingBraceRule.groovy 0000644 0001750 0001750 00000012302 12414277432 031727 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.ConstructorNode
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.expr.MapEntryExpression
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.MethodNode
/**
* Check that there is at least one space (blank) or whitespace before each closing brace ("}").
* This checks method/class/interface declarations, closure expressions and block statements.
*
* @author Chris Mair
*/
class SpaceBeforeClosingBraceRule extends AbstractAstVisitorRule {
String name = 'SpaceBeforeClosingBrace'
int priority = 3
Class astVisitorClass = SpaceBeforeClosingBraceAstVisitor
boolean checkClosureMapEntryValue = true
boolean ignoreEmptyBlock = false
}
class SpaceBeforeClosingBraceAstVisitor extends AbstractSpaceAroundBraceAstVisitor {
@Override
protected void visitClassEx(ClassNode node) {
def line = lastSourceLineOrEmpty(node)
def indexOfBrace = line.indexOf('}')
if (indexOfBrace > 1) {
if (isNotWhitespace(line, indexOfBrace) && checkIsEmptyBlock(line, indexOfBrace)) {
def typeName = node.isInterface() ? 'interface' : (node.isEnum() ? 'enum' : 'class')
addViolation(node, "The closing brace for $typeName $currentClassName is not preceded by a space or whitespace")
}
}
super.visitClassEx(node)
}
@Override
protected void visitMethodEx(MethodNode node) {
processMethodNode(node)
super.visitMethodEx(node)
}
@Override
void visitConstructor(ConstructorNode node) {
processMethodNode(node)
super.visitConstructor(node)
}
private void processMethodNode(MethodNode node) {
if (isFirstVisit(node.code) && node.code && !AstUtil.isFromGeneratedSourceCode(node)) {
def line = lastSourceLineOrEmpty(node.code)
def lastCol = node.code.lastColumnNumber
if (line.size() >= lastCol && isNotWhitespace(line, lastCol - 1) && line[lastCol - 1] == '}' && checkIsEmptyBlock(line, lastCol - 1)) {
addOpeningBraceViolation(node.code, 'block')
}
}
}
@Override
void visitBlockStatement(BlockStatement block) {
if (isFirstVisit(block) && !AstUtil.isFromGeneratedSourceCode(block)) {
def startLine = sourceLineOrEmpty(block)
def line = lastSourceLineOrEmpty(block)
def lastCol = block.lastColumnNumber
def startCol = block.columnNumber
if (startLine[startCol - 1] == '{') {
int lastIndex = indexOfClosingBrace(line, lastCol)
if (isNotWhitespace(line, lastIndex) && checkIsEmptyBlock(line, lastIndex)) {
addOpeningBraceViolation(block, 'block')
}
}
}
super.visitBlockStatement(block)
}
@Override
void visitClosureExpression(ClosureExpression expression) {
isFirstVisit(expression.code) // Register the code block so that it will be ignored in visitBlockStatement()
if (isFirstVisit(expression)) {
def line = lastSourceLineOrEmpty(expression)
def lastCol = expression.lastColumnNumber
int lastIndex = indexOfClosingBrace(line, lastCol)
if (isNotWhitespace(line, lastIndex) && checkIsEmptyBlock(line, lastIndex)) {
addOpeningBraceViolation(expression, 'closure')
}
}
super.visitClosureExpression(expression)
}
@Override
void visitMapEntryExpression(MapEntryExpression expression) {
if (!rule.checkClosureMapEntryValue && expression.valueExpression instanceof ClosureExpression) {
isFirstVisit(expression.valueExpression) // Register the closure so that it will be ignored in visitClosureExpression()
}
super.visitMapEntryExpression(expression)
}
private void addOpeningBraceViolation(ASTNode node, String keyword) {
addViolation(node, "The closing brace for the $keyword in class $currentClassName is not preceded by a space or whitespace")
}
private boolean checkIsEmptyBlock(String line, int indexOfBrace) {
if (rule.ignoreEmptyBlock ) {
return isNotCharacter(line, '{' as char, indexOfBrace)
}
return true
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAroundClosureArrowRule.groovy 0000644 0001750 0001750 00000003305 12170246030 032041 0 ustar ebourg ebourg /*
* Copyright 2013 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.formatting
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
/**
* Checks that there is whitespace around the closure arrow (->) symbol
*
* @author Chris Mair
*/
class SpaceAroundClosureArrowRule extends AbstractAstVisitorRule {
String name = 'SpaceAroundClosureArrow'
int priority = 3
Class astVisitorClass = SpaceAroundClosureArrowAstVisitor
}
class SpaceAroundClosureArrowAstVisitor extends AbstractAstVisitor {
@Override
void visitClosureExpression(ClosureExpression expression) {
def line = sourceLine(expression) + ' ' // add trailing space in case -> is at end of line
if (line.contains('->') && !(line =~ /\s\-\>\s/)) {
addViolation(expression, "The closure arrow (->) within class $currentClassName is not surrounded by a space or whitespace")
//"The operator \"?\" within class $currentClassName is not followed by a space or whitespace")
}
super.visitClosureExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAfterOpeningBraceRule.groovy 0000644 0001750 0001750 00000011730 12414277432 031573 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.MapEntryExpression
import org.codehaus.groovy.ast.ConstructorNode
import org.codehaus.groovy.ast.MethodNode
/**
* Check that there is at least one space (blank) or whitespace after each opening brace ("{").
* This checks method/class/interface declarations, closure expressions and block statements.
*
* @author Chris Mair
*/
class SpaceAfterOpeningBraceRule extends AbstractAstVisitorRule {
String name = 'SpaceAfterOpeningBrace'
int priority = 3
Class astVisitorClass = SpaceAfterOpeningBraceAstVisitor
boolean checkClosureMapEntryValue = true
boolean ignoreEmptyBlock = false
}
class SpaceAfterOpeningBraceAstVisitor extends AbstractSpaceAroundBraceAstVisitor {
@Override
protected void visitClassEx(ClassNode node) {
def line = sourceLineOrEmpty(node)
def indexOfBrace = line.indexOf('{')
if (indexOfBrace != -1 && isNotWhitespace(line, indexOfBrace + 2) && checkIsEmptyBlock(line, indexOfBrace + 2)) {
def typeName = node.isInterface() ? 'interface' : (node.isEnum() ? 'enum' : 'class')
addViolation(node, "The opening brace for $typeName $currentClassName is not followed by a space or whitespace")
}
super.visitClassEx(node)
}
@Override
void visitConstructor(ConstructorNode node) {
// The AST for constructors is "special". The BlockStatement begins on the line following the
// opening brace if it is a multi-line method. Bug?
isFirstVisit(node.code) // Register the code block so that it will be ignored in visitBlockStatement()
def line = sourceLineOrEmpty(node)
if (line =~ /\{\S/) {
addOpeningBraceViolation(node, 'block')
}
super.visitConstructor(node)
}
@Override
void visitBlockStatement(BlockStatement block) {
if (isFirstVisit(block) && !AstUtil.isFromGeneratedSourceCode(block)) {
def line = sourceLineOrEmpty(block)
def startCol = block.columnNumber
if (line[startCol - 1] == '{' && isNotWhitespace(line, startCol + 1) && checkIsEmptyBlock(line, startCol + 1)) {
addOpeningBraceViolation(block, 'block')
}
}
super.visitBlockStatement(block)
}
@Override
void visitClosureExpression(ClosureExpression expression) {
isFirstVisit(expression.code) // Register the code block so that it will be ignored in visitBlockStatement()
if (isFirstVisit(expression)) {
def line = sourceLineOrEmpty(expression)
def startCol = expression.columnNumber
if (isNotWhitespace(line, startCol + 1) && checkIsEmptyBlock(line, startCol + 1)) {
addOpeningBraceViolation(expression, 'closure')
}
}
super.visitClosureExpression(expression)
}
@Override
protected void visitMethodEx(MethodNode node) {
if (node.code) {
def line = sourceLineOrEmpty(node.code)
def startCol = node.code.columnNumber
if (startCol > 1 && line[startCol - 2] == '{') {
addOpeningBraceViolation(node.code, 'block')
}
}
}
@Override
void visitMapEntryExpression(MapEntryExpression expression) {
if (!rule.checkClosureMapEntryValue && expression.valueExpression instanceof ClosureExpression) {
isFirstVisit(expression.valueExpression) // Register the closure so that it will be ignored in visitClosureExpression()
}
super.visitMapEntryExpression(expression)
}
private void addOpeningBraceViolation(ASTNode node, String keyword) {
addViolation(node, "The opening brace for the $keyword in class $currentClassName is not followed by a space or whitespace")
}
private boolean checkIsEmptyBlock(String line, int indexOfBrace) {
if (rule.ignoreEmptyBlock ) {
return isNotCharacter(line, '}' as char, indexOfBrace)
}
return true
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAfterIfRule.groovy 0000644 0001750 0001750 00000002477 12311373552 027601 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Check that there is exactly one space (blank) after the if keyword and before the opening parenthesis.
*
* @author Chris Mair
*/
class SpaceAfterIfRule extends AbstractAstVisitorRule {
String name = 'SpaceAfterIf'
int priority = 3
Class astVisitorClass = SpaceAfterIfAstVisitor
}
class SpaceAfterIfAstVisitor extends AbstractSingleSpaceAfterKeywordAstVisitor {
@Override
void visitIfElse(IfStatement ifElse) {
checkForSingleSpaceAndOpeningParenthesis(ifElse, 'if')
super.visitIfElse(ifElse)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAfterCatchRule.groovy 0000644 0001750 0001750 00000002561 12054251720 030253 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.stmt.CatchStatement
/**
* Check that there is exactly one space (blank) after the catch keyword and before the opening parenthesis.
*
* @author Chris Mair
*/
class SpaceAfterCatchRule extends AbstractAstVisitorRule {
String name = 'SpaceAfterCatch'
int priority = 3
Class astVisitorClass = SpaceAfterElseAstVisitor
}
class SpaceAfterElseAstVisitor extends AbstractSingleSpaceAfterKeywordAstVisitor {
@Override
void visitCatchStatement(CatchStatement statement) {
checkForSingleSpaceAndOpeningParenthesis(statement, 'catch')
super.visitCatchStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/FileEndsWithoutNewlineRule.groovy 0000644 0001750 0001750 00000002720 12312152270 031664 0 ustar ebourg ebourg /*
* Copyright 2014 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.formatting
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Makes sure the source code file ends with a newline character.
*
* @author Joe Sondow
*/
class FileEndsWithoutNewlineRule extends AbstractRule {
String name = 'FileEndsWithoutNewline'
int priority = 3
/**
* Apply the rule to the given source, writing violations to the given list.
* @param sourceCode The source to check
* @param violations A list of Violations that may be added to. It can be an empty list
*/
@Override
void applyTo(SourceCode sourceCode, List violations) {
if (!sourceCode.text.endsWith('\n')) {
violations.add(createViolation(sourceCode.lines.size() - 1, sourceCode.lines[-1],
"File $sourceCode.name does not end with a newline"))
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/BracesForTryCatchFinallyRule.groovy 0000644 0001750 0001750 00000014273 12050064304 032121 0 ustar ebourg ebourg /*
* Copyright 2011 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.formatting
import org.codehaus.groovy.ast.stmt.CatchStatement
import org.codehaus.groovy.ast.stmt.TryCatchStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Checks the location of the opening brace ({) for try statements, the location
* of the 'catch' keyword and corresponding opening braces, and the location of the 'finally'
* keyword and the corresponding opening braces. By default, requires opening braces on the
* same line, but the sameLine property can be set to false to override this.
*
* By default does not validate catch and finally clauses, to turn this on set properties
* validateCatch and validateFinally to true respectively. The catch and finally handling
* defaults to using the sameLine value so if sameLine is true, we expect "} catch(x) {"
* and "} finally {". For fine grained control, use boolean properties catchOnSameLineAsClosingBrace,
* catchOnSameLineAsOpeningBrace, finallyOnSameLineAsClosingBrace, finallyOnSameLineAsOpeningBrace
*
* @author Geli Crick
* @author Hamlet D'Arcy
* @author Matias Bjarland
*/
class BracesForTryCatchFinallyRule extends AbstractAstVisitorRule {
String name = 'BracesForTryCatchFinally'
int priority = 2
Class astVisitorClass = BracesForTryCatchFinallyAstVisitor
boolean sameLine = true
boolean validateCatch = false
Boolean catchOnSameLineAsClosingBrace
Boolean catchOnSameLineAsOpeningBrace
boolean validateFinally = false
Boolean finallyOnSameLineAsClosingBrace
Boolean finallyOnSameLineAsOpeningBrace
}
class BracesForTryCatchFinallyAstVisitor extends AbstractAstVisitor {
@Override
void visitTryCatchFinally(TryCatchStatement node) {
BracesForTryCatchFinallyRule myRule = rule as BracesForTryCatchFinallyRule
if (myRule.sameLine) {
if(!sourceLineTrimmed(node)?.contains('{')) {
addViolation(node, "Opening brace should be on the same line as 'try'")
}
} else {
if(sourceLineTrimmed(node)?.contains('{')) {
addViolation(node, "Opening brace should not be on the same line as 'try'")
}
}
visitCatch(myRule, node)
visitFinally(myRule, node)
super.visitTryCatchFinally(node)
}
void visitCatch(BracesForTryCatchFinallyRule myRule, TryCatchStatement node) {
//TODO: Understand AstUtil.isBlock and isFirstVisit and apply them as appropriate to the below block
if (myRule.validateCatch && node.catchStatements) {
//if user has not explicitly set the catch brace settings, 'inherit' them from sameLine
if (myRule.catchOnSameLineAsClosingBrace == null) {
myRule.catchOnSameLineAsClosingBrace = myRule.sameLine
}
if (myRule.catchOnSameLineAsOpeningBrace == null) {
myRule.catchOnSameLineAsOpeningBrace = myRule.sameLine
}
node.catchStatements.each { CatchStatement stmt ->
def srcLine = sourceLineTrimmed(stmt)
if (myRule.catchOnSameLineAsClosingBrace && !srcLine?.contains('}')) {
addViolation(stmt, "'catch' should be on the same line as the closing brace")
} else if (!myRule.catchOnSameLineAsClosingBrace && srcLine?.contains('}')) {
addViolation(stmt, "'catch' should not be on the same line as the closing brace")
}
if (myRule.catchOnSameLineAsOpeningBrace && !srcLine?.contains('{')) {
addViolation(stmt, "Opening brace should be on the same line as 'catch'")
} else if (!myRule.catchOnSameLineAsOpeningBrace && srcLine?.contains('}')) {
addViolation(stmt, "Opening brace should not be on the same line as 'catch'")
}
}
}
}
void visitFinally(BracesForTryCatchFinallyRule myRule, TryCatchStatement node) {
//TODO: Understand AstUtil.isBlock and isFirstVisit and apply them as appropriate to the below block
//if user has not explicitly set the finally brace settings, 'inherit' them from sameLine
if (myRule.finallyOnSameLineAsClosingBrace == null) {
myRule.finallyOnSameLineAsClosingBrace = myRule.sameLine
}
if (myRule.finallyOnSameLineAsOpeningBrace == null) {
myRule.finallyOnSameLineAsOpeningBrace = myRule.sameLine
}
if (myRule.validateFinally && node.finallyStatement) {
def stmt = node.finallyStatement
def srcLine = sourceLineTrimmed(stmt)
if (myRule.finallyOnSameLineAsClosingBrace && srcLine && !srcLine?.contains('}')) {
addViolation(stmt, "'finally' should be on the same line as the closing brace")
} else if (!myRule.finallyOnSameLineAsClosingBrace && srcLine?.contains('}')) {
addViolation(stmt, "'finally' should not be on the same line as the closing brace")
}
if (myRule.finallyOnSameLineAsOpeningBrace && srcLine && !srcLine?.contains('{')) {
addViolation(stmt, "Opening brace should be on the same line as 'finally'")
} else if (!myRule.catchOnSameLineAsOpeningBrace && srcLine?.contains('}')) {
addViolation(stmt, "Opening brace should not be on the same line as 'finally'")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/BracesForMethodRule.groovy 0000644 0001750 0001750 00000005035 12461207021 030276 0 ustar ebourg ebourg /*
* Copyright 2011 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.formatting
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Checks the location of the opening brace ({) for constructors and methods. By default, requires them on the same line, but the sameLine property can be set to false to override this.
*
* @author Geli Crick
* @author Hamlet D'Arcy
*/
class BracesForMethodRule extends AbstractAstVisitorRule {
String name = 'BracesForMethod'
int priority = 2
Class astVisitorClass = BracesForMethodAstVisitor
boolean sameLine = true
}
class BracesForMethodAstVisitor extends AbstractAstVisitor {
@Override
void visitConstructorOrMethod(MethodNode node, boolean isConstructor) {
if (node.declaringClass?.isInterface() || node.isAbstract()) {
return
}
String lastLine
if (node.exceptions) {
lastLine = lastSourceLineTrimmed(node.exceptions[-1])
} else if (node.parameters) {
lastLine = lastSourceLineTrimmed(node.parameters[-1])
} else {
lastLine = sourceLineTrimmed(node)
}
if (rule.sameLine) {
if(!(containsOpeningBraceAfterParenthesis(lastLine))) {
addViolation(node, "Opening brace for the method $node.name should start on the same line")
}
} else {
if (containsOpeningBraceAfterParenthesis(lastLine)) {
addViolation(node, "Opening brace for the method $node.name should start on a new line")
}
}
super.visitConstructorOrMethod(node, isConstructor)
}
private containsOpeningBraceAfterParenthesis(String lastLine) {
int parenthesisIndex = lastLine?.indexOf(')') ?: 0
lastLine?.indexOf('{', parenthesisIndex) >= 0
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/MissingBlankLineAfterPackageRule.groovy 0000644 0001750 0001750 00000002663 12312152270 032722 0 ustar ebourg ebourg /*
* Copyright 2014 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.formatting
import org.codehaus.groovy.ast.PackageNode
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Makes sure there is a blank line after the package statement of a source code file.
*
* @author Joe Sondow
*/
class MissingBlankLineAfterPackageRule extends AbstractRule {
String name = 'MissingBlankLineAfterPackage'
int priority = 3
@Override
void applyTo(SourceCode sourceCode, List violations) {
PackageNode packageNode = sourceCode.ast?.package
if (packageNode && !sourceCode.line(packageNode.lineNumber).isEmpty()) {
violations.add(createViolation(packageNode.lineNumber, sourceCode.line(packageNode.lineNumber),
"Missing blank line after package statement in file $sourceCode.name"))
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAfterSemicolonRule.groovy 0000644 0001750 0001750 00000005565 12311373552 031174 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.stmt.ForStatement
import org.codehaus.groovy.ast.expr.ClosureListExpression
/**
* Check that there is at least one space (blank) or whitespace following a semicolon that separates:
* - multiple statements on a single line
* - the clauses within a classic for loop, e.g. for (i=0;i<10;i++)
*
* @author Chris Mair
*/
class SpaceAfterSemicolonRule extends AbstractAstVisitorRule {
String name = 'SpaceAfterSemicolon'
int priority = 3
Class astVisitorClass = SpaceAfterSemicolonAstVisitor
}
class SpaceAfterSemicolonAstVisitor extends AbstractAstVisitor {
@Override
void visitBlockStatement(BlockStatement block) {
def lastLine
def lastColumn
block.statements.each { statementExpression ->
if (lastLine && statementExpression.lineNumber == lastLine && statementExpression.columnNumber == lastColumn + 1) {
def stmtText = AstUtil.getNodeText(statementExpression, sourceCode)
addViolation(statementExpression, "The statement \"${stmtText}\" within class $currentClassName is not preceded by a space or whitespace")
}
lastLine = statementExpression.lineNumber
lastColumn = statementExpression.lastColumnNumber
}
super.visitBlockStatement(block)
}
@Override
void visitForLoop(ForStatement forLoop) {
if (forLoop.collectionExpression instanceof ClosureListExpression) {
def lastColumn
forLoop.collectionExpression.expressions.each { expression ->
if (lastColumn && expression.columnNumber == lastColumn + 1) {
def exprText = AstUtil.getNodeText(expression, sourceCode)
addViolation(forLoop, "The for loop expression \"$exprText\" within class $currentClassName is not preceded by a space or whitespace")
}
lastColumn = expression.lastColumnNumber
}
}
super.visitForLoop(forLoop)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAfterWhileRule.groovy 0000644 0001750 0001750 00000002525 12311373552 030305 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codehaus.groovy.ast.stmt.WhileStatement
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Check that there is exactly one space (blank) after the while keyword and before the opening parenthesis.
*
* @author Chris Mair
*/
class SpaceAfterWhileRule extends AbstractAstVisitorRule {
String name = 'SpaceAfterWhile'
int priority = 3
Class astVisitorClass = SpaceAfterWhileAstVisitor
}
class SpaceAfterWhileAstVisitor extends AbstractSingleSpaceAfterKeywordAstVisitor {
@Override
void visitWhileLoop(WhileStatement loop) {
checkForSingleSpaceAndOpeningParenthesis(loop, 'while')
super.visitWhileLoop(loop)
}
}
././@LongLink 0000644 0000000 0000000 00000000154 00000000000 011603 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/AbstractSingleSpaceAfterKeywordAstVisitor.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/AbstractSingleSpaceAfterKeywordAstVisitor0000644 0001750 0001750 00000003134 12461172524 033362 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codehaus.groovy.ast.ASTNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.util.AstUtil
/**
* Abstract superclass for AstVisitor classes that checks that there is exactly one space (blank) after a keyword
* and before the opening parenthesis.
*
* @author Chris Mair
*/
class AbstractSingleSpaceAfterKeywordAstVisitor extends AbstractAstVisitor {
protected void checkForSingleSpaceAndOpeningParenthesis(ASTNode node, String keyword) {
if (AstUtil.isFromGeneratedSourceCode(node)) {
return
}
def line = sourceLine(node)
int col = node.columnNumber
int keywordSize = keyword.size()
if (line[col + keywordSize - 1] != ' ' || line.size() < col + keywordSize || line[col + keywordSize] != '(') {
addViolation(node, "The $keyword keyword within class $currentClassName is not followed by a single space")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/BracesForIfElseRule.groovy 0000644 0001750 0001750 00000012270 12051601044 030222 0 ustar ebourg ebourg /*
* Copyright 2011 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.formatting
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Checks the location of the opening brace ({) for if statements and optionally closing and opening braces
* for else statements. By default, requires them on the same line, but the sameLine property can be set to
* false to override this. To enable else checking, set the validateElse property to true. For more fine grained
* control, use boolean properties elseOnSameLineAsClosingBrace and elseOnSameLineAsOpeningBrace
*
* Example:
*
*
*
* A - checked and defaults to no errors since the brace is on the same line
* B - checked if option validateElse is set to true. Validation result controlled by boolean
* options elseOnSameLineAsClosingBrace and elseOnSameLineAsOpeningBrace
* C - same as B
*
* @author Hamlet D'Arcy
* @author Geli Crick
* @author Matias Bjarland
*/
class BracesForIfElseRule extends AbstractAstVisitorRule {
String name = 'BracesForIfElse'
int priority = 2
Class astVisitorClass = BracesForIfElseAstVisitor
boolean sameLine = true
boolean validateElse = false
Boolean elseOnSameLineAsClosingBrace
Boolean elseOnSameLineAsOpeningBrace
}
class BracesForIfElseAstVisitor extends AbstractAstVisitor {
@Override
void visitIfElse(IfStatement node) {
BracesForIfElseRule myRule = rule as BracesForIfElseRule
if (isFirstVisit(node) && AstUtil.isBlock(node.ifBlock)) {
if (myRule.sameLine) {
if(!lastSourceLineTrimmed(node.booleanExpression)?.contains('{')) {
addViolation(node, "Opening brace should be on the same line as 'if'")
}
} else {
if(lastSourceLineTrimmed(node.booleanExpression)?.contains('{')) {
addViolation(node, "Opening brace should not be on the same line as 'if'")
}
}
}
visitElse(myRule, node)
super.visitIfElse(node)
}
void visitElse(BracesForIfElseRule myRule, IfStatement node) {
//TODO: Understand isFirstVisit and apply them as appropriate to the below block
if (myRule.validateElse && node.elseBlock) {
//if user has not explicitly set the else brace settings, 'inherit' them from sameLine
if (myRule.elseOnSameLineAsClosingBrace == null) {
myRule.elseOnSameLineAsClosingBrace = myRule.sameLine
}
if (myRule.elseOnSameLineAsOpeningBrace == null) {
myRule.elseOnSameLineAsOpeningBrace = myRule.sameLine
}
def srcLine = sourceLineTrimmed(node.elseBlock)
visitElseClosingBrace(myRule, node, srcLine)
visitElseOpeningBrace(myRule, node, srcLine)
}
}
void visitElseClosingBrace(BracesForIfElseRule myRule, IfStatement node, String srcLine) {
//only test for else closing curlies if the if statement has curlies to test for (i.e. is not one-line)
if (AstUtil.isBlock(node.ifBlock)) {
if (myRule.elseOnSameLineAsClosingBrace && srcLine && !(srcLine?.contains('else') && srcLine?.contains('}'))) {
addViolation(node.elseBlock, "'else' should be on the same line as the closing brace")
} else if (!myRule.elseOnSameLineAsClosingBrace && srcLine?.contains('else') && srcLine?.contains('}')) {
addViolation(node.elseBlock, "'else' should not be on the same line as the closing brace")
}
}
}
void visitElseOpeningBrace(BracesForIfElseRule myRule, IfStatement node, String srcLine) {
//only test for else opening curlies if the else statement has curlies to test for (i.e. is not one-line)
if (AstUtil.isBlock(node.elseBlock)) {
if (myRule.elseOnSameLineAsOpeningBrace && srcLine && !(srcLine?.contains('else') && srcLine?.contains('{'))) {
addViolation(node.elseBlock, "Opening brace should be on the same line as 'else'")
} else if (!myRule.elseOnSameLineAsOpeningBrace && srcLine?.contains('else') && srcLine?.contains('{')) {
addViolation(node.elseBlock, "Opening brace should not be on the same line as 'else'")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/BracesForClassRule.groovy 0000644 0001750 0001750 00000006352 12313644537 030143 0 ustar ebourg ebourg /*
* Copyright 2011 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.formatting
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractRule
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
import org.codenarc.util.AstUtil
/**
* Checks the location of the opening brace ({) for classes. By default, requires them on the same line, but the sameLine property can be set to false to override this.
*
* @author Hamlet D'Arcy
* @author Geli Crick
*/
class BracesForClassRule extends AbstractRule {
String name = 'BracesForClass'
int priority = 2
boolean sameLine = true
@Override
void applyTo(SourceCode sourceCode, List violations) {
sourceCode?.ast?.classes?.each { ClassNode classNode ->
def (lineNumber, sourceLine) = findOpeningBraceLine(sourceCode, classNode)
// Groovy 1.7 returns -1 as line number for a ClassNode representing an enum.
// In this case we ignore the rule
if (lineNumber != -1) {
applyToClassNode(classNode, lineNumber, sourceLine, violations)
}
}
}
private applyToClassNode(ClassNode classNode, int lineNumber, String sourceLine, List violations) {
if (sameLine) {
if (sourceLine?.startsWith('{')) {
violations.add(new Violation(
rule: this,
lineNumber: lineNumber,
sourceLine: sourceLine,
message: "Opening brace for the ${classNode.isInterface() ? 'interface' : 'class'} $classNode.name should start on the same line"))
}
} else {
if (!sourceLine?.startsWith('{') && !definesAnnotationType(sourceLine)) {
violations.add(new Violation(
rule: this,
lineNumber: lineNumber,
sourceLine: sourceLine,
message: "Opening brace for the ${classNode.isInterface() ? 'interface' : 'class'} $classNode.name should start on a new line"))
}
}
}
private definesAnnotationType(String sourceLine) {
sourceLine?.contains('@interface')
}
private findOpeningBraceLine(SourceCode sourceCode, ASTNode node) {
int line = AstUtil.findFirstNonAnnotationLine(node, sourceCode)
def sourceLine = sourceCode.line(line - 1)
while (sourceLine != null) {
if (sourceLine?.contains('{')) {
return [line, sourceLine]
}
line++
sourceLine = sourceCode.line(line - 1)
}
return [line, null]
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAfterSwitchRule.groovy 0000644 0001750 0001750 00000002553 12054251646 030502 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.stmt.SwitchStatement
/**
* Check that there is exactly one space (blank) after the switch keyword and before the opening parenthesis.
*
* @author Chris Mair
*/
class SpaceAfterSwitchRule extends AbstractAstVisitorRule {
String name = 'SpaceAfterSwitch'
int priority = 3
Class astVisitorClass = SpaceAfterSwitchAstVisitor
}
class SpaceAfterSwitchAstVisitor extends AbstractSingleSpaceAfterKeywordAstVisitor {
@Override
void visitSwitch(SwitchStatement statement) {
checkForSingleSpaceAndOpeningParenthesis(statement, 'switch')
super.visitSwitch(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAroundMapEntryColonRule.groovy 0000644 0001750 0001750 00000005170 12407150242 032150 0 ustar ebourg ebourg /*
* Copyright 2013 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.formatting
import org.codehaus.groovy.ast.expr.MapEntryExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Check for configured formatting of whitespace around colons for literal Map entries
*
* @author Chris Mair
*/
class SpaceAroundMapEntryColonRule extends AbstractAstVisitorRule {
String name = 'SpaceAroundMapEntryColon'
int priority = 3
String characterBeforeColonRegex = /\S/
String characterAfterColonRegex = /\S/
Class astVisitorClass = SpaceAroundMapEntryColonAstVisitor
}
class SpaceAroundMapEntryColonAstVisitor extends AbstractAstVisitor {
@Override
void visitMapEntryExpression(MapEntryExpression expression) {
if (expression.lineNumber != -1) {
handleMapExpression(expression)
}
super.visitMapEntryExpression(expression)
}
private void handleMapExpression(MapEntryExpression expression) {
def line = sourceLine(expression)
def colonIndex = expression.lastColumnNumber - 1
def charBeforeColon = line[colonIndex - 2]
// Handle special case of colon as the last char of the line
def charAfterColon = colonIndex >= line.size() ? '\n' : line[colonIndex]
if (!(charBeforeColon ==~ rule.characterBeforeColonRegex)) {
String keyName = expression.keyExpression.text
addViolation(expression, violationMessage(keyName, 'preceded', rule.characterBeforeColonRegex))
}
if (!(charAfterColon ==~ rule.characterAfterColonRegex)) {
String keyName = expression.keyExpression.text
addViolation(expression, violationMessage(keyName, 'followed', rule.characterAfterColonRegex))
}
}
private String violationMessage(String keyName, String precededOrFollowed, String regex) {
return "The colon for the literal Map entry for key [$keyName] within class $currentClassName" +
" is not $precededOrFollowed by a match for regular expression [$regex]"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/MissingBlankLineAfterImportsRule.groovy 0000644 0001750 0001750 00000003255 12311450700 033020 0 ustar ebourg ebourg /*
* Copyright 2014 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.formatting
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Makes sure there is a blank line after the imports of a source code file.
*/
class MissingBlankLineAfterImportsRule extends AbstractRule {
String name = 'MissingBlankLineAfterImports'
int priority = 3
@Override
void applyTo(SourceCode sourceCode, List violations) {
if (sourceCode.ast?.imports) {
// Before Groovy 2.1.3 some ImportNode objects lack a way to get the line number, so just parse the text.
// https://jira.codehaus.org/browse/GROOVY-6094
List lines = sourceCode.lines
int lastImportLineNumber = lines.findLastIndexOf { it.trim().startsWith('import ') }
if (lastImportLineNumber > -1 && !lines[lastImportLineNumber + 1].trim().isEmpty()) {
violations.add(createViolation(lastImportLineNumber + 1, lines[lastImportLineNumber + 1],
"Missing blank line after imports in file $sourceCode.name"))
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/AbstractSpaceAroundBraceAstVisitor.groovy0000644 0001750 0001750 00000005211 12461202660 033314 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.expr.GStringExpression
import org.codenarc.rule.AbstractAstVisitor
/**
* Abstract superclass for AstVisitor classes dealing with space around braces
*
* @author Chris Mair
*/
abstract class AbstractSpaceAroundBraceAstVisitor extends AbstractAstVisitor {
private final Stack gStringExpressionsStack = [] as Stack
@Override
void visitGStringExpression(GStringExpression expression) {
gStringExpressionsStack.push(expression)
super.visitGStringExpression(expression)
gStringExpressionsStack.pop()
}
protected boolean isNotInsideGString() {
return gStringExpressionsStack.empty()
}
protected String sourceLineOrEmpty(node) {
(node.lineNumber == -1 || (node instanceof ClassNode && node.script)) ? '' : sourceLine(node)
}
protected String lastSourceLineOrEmpty(node) {
(node.lineNumber == -1 || (node instanceof ClassNode && node.script)) ? '' : lastSourceLine(node)
}
/**
* Return true if the specified (1-based) index is valid and the character at that index is not a whitespace character
* @param line - the source line to be checked
* @param index - the 1-based index of the character to be checked
* @return true only if the character is not a whitespace character
*/
protected boolean isNotWhitespace(String line, int index) {
index in 1..line.size() && !Character.isWhitespace(line[index - 1] as char)
}
protected boolean isNotCharacter(String line, char c, int index) {
index in 1..line.size() && line[index - 1] as char != c
}
protected int indexOfClosingBrace(String line, int blockLastColumn) {
int index = blockLastColumn - 2
while(index >= 0) {
if (line[index] == '}') {
return index
}
index--
}
return index
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/BlankLineBeforePackageRule.groovy 0000644 0001750 0001750 00000003005 12311371417 031525 0 ustar ebourg ebourg /*
* Copyright 2014 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.formatting
import org.codehaus.groovy.ast.PackageNode
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Makes sure there are no blank lines before the package declaration of a source code file.
*
* @author Joe Sondow
*/
class BlankLineBeforePackageRule extends AbstractRule {
String name = 'BlankLineBeforePackage'
int priority = 3
@Override
void applyTo(SourceCode sourceCode, List violations) {
PackageNode packageNode = sourceCode.ast?.package
if (packageNode) {
for (int index = 0; index < packageNode.lineNumber; index++) {
if (sourceCode.line(index).isEmpty()) {
violations.add(createViolation(index, sourceCode.line(index),
"Blank line precedes package declaration in file $sourceCode.name"))
}
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/ConsecutiveBlankLinesRule.groovy 0000644 0001750 0001750 00000003175 12311370173 031527 0 ustar ebourg ebourg /*
* Copyright 2014 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.formatting
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Makes sure there are no consecutive lines that are either blank or whitespace only.
*
* @author Joe Sondow
*/
class ConsecutiveBlankLinesRule extends AbstractRule {
String name = 'ConsecutiveBlankLines'
int priority = 3
/**
* Apply the rule to the given source, writing violations to the given list.
*
* @param sourceCode the source to check
* @param violations a list of Violations that may be added to. It can be an empty list
*/
@Override
void applyTo(SourceCode sourceCode, List violations) {
List lines = sourceCode.getLines()
for (int index = 1; index < lines.size(); index++) {
String line = lines[index]
if (line.trim().isEmpty() && lines[index - 1].trim().isEmpty()) {
violations.add(createViolation(index, line, "File $sourceCode.name has consecutive blank lines"))
}
}
}
}
././@LongLink 0000644 0000000 0000000 00000000171 00000000000 011602 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/ClosureStatementOnOpeningLineOfMultipleLineClosureRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/ClosureStatementOnOpeningLineOfMultipleLi0000644 0001750 0001750 00000004054 12325017373 033337 0 ustar ebourg ebourg /*
* Copyright 2013 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.formatting
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Checks for closure logic on first line (after ->) for a multi-line closure
*
* @author Chris Mair
*/
class ClosureStatementOnOpeningLineOfMultipleLineClosureRule extends AbstractAstVisitorRule {
String name = 'ClosureStatementOnOpeningLineOfMultipleLineClosure'
int priority = 3
Class astVisitorClass = ClosureStatementOnOpeningLineOfMultipleLineClosureAstVisitor
}
class ClosureStatementOnOpeningLineOfMultipleLineClosureAstVisitor extends AbstractAstVisitor {
@Override
void visitClosureExpression(ClosureExpression expression) {
def block = expression.code
boolean hasAtLeastOneStatement = !block.isEmpty()
if (hasAtLeastOneStatement) {
int closureStartLineNumber = expression.lineNumber
def lastStatement = block.statements[-1]
boolean isMultiLineClosure = lastStatement.lastLineNumber > block.lineNumber
boolean hasCodeOnStartingLine = closureStartLineNumber == block.lineNumber
if (isMultiLineClosure && hasCodeOnStartingLine) {
addViolation(expression, "The multi-line closure within class $currentClassName contains a statement on the opening line of the closure.")
}
}
super.visitClosureExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAfterCommaRule.groovy 0000644 0001750 0001750 00000012607 12466525534 030305 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.expr.ListExpression
import org.codehaus.groovy.ast.expr.MapExpression
import org.codehaus.groovy.ast.expr.Expression
/**
* Check that there is at least one space (blank) or whitespace following each comma. That includes checks
* for method and closure declaration parameter lists, method call parameter lists, Map literals and List literals.
*
* @author Chris Mair
*/
class SpaceAfterCommaRule extends AbstractAstVisitorRule {
// Initialize displayed text for AST ClosureExpression
{
ClosureExpression.metaClass.getText = { return CLOSURE_TEXT }
}
String name = 'SpaceAfterComma'
int priority = 3
Class astVisitorClass = SpaceAfterCommaAstVisitor
}
class SpaceAfterCommaAstVisitor extends AbstractAstVisitor {
@Override
protected void visitConstructorOrMethod(MethodNode node, boolean isConstructor) {
def lastColumn
node.parameters.each { parameter ->
if (lastColumn && parameter.columnNumber == lastColumn + 1) {
addViolation(node, "The parameter ${parameter.name} of method ${node.name} within class $currentClassName is not preceded by a space or whitespace")
}
lastColumn = parameter.lastColumnNumber
}
super.visitConstructorOrMethod(node, isConstructor)
}
@Override
void visitClosureExpression(ClosureExpression expression) {
if (isFirstVisit(expression)) {
def lastColumn
expression.parameters.each { parameter ->
if (lastColumn && parameter.columnNumber == lastColumn + 1) {
addViolation(expression, "The closure parameter ${parameter.name} within class $currentClassName is not preceded by a space or whitespace")
}
lastColumn = parameter.lastColumnNumber
}
}
super.visitClosureExpression(expression)
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
processMethodOrConstructorCall(call)
super.visitMethodCallExpression(call)
}
@Override
void visitConstructorCallExpression(ConstructorCallExpression call) {
processMethodOrConstructorCall(call)
super.visitConstructorCallExpression(call)
}
private void processMethodOrConstructorCall(Expression call) {
if (isFirstVisit(call)) {
def arguments = call.arguments
def parameterExpressions = arguments.expressions
def lastColumn
parameterExpressions.each { e ->
if (lastColumn && e.columnNumber == lastColumn + 1 && !isClosureParameterOutsideParentheses(e, arguments)) {
addViolation(call, "The parameter ${e.text} in the call to method ${call.methodAsString} within class $currentClassName is not preceded by a space or whitespace")
}
lastColumn = e.lastColumnNumber
}
}
}
private boolean isClosureParameterOutsideParentheses(Expression e, arguments) {
e instanceof ClosureExpression && e.columnNumber > arguments.lastColumnNumber
}
@Override
void visitListExpression(ListExpression listExpression) {
if (isFirstVisit(listExpression)) {
def lastColumn
listExpression.expressions.each { e ->
if (lastColumn && e.columnNumber == lastColumn + 1) {
addViolation(listExpression, "The list element ${e.text} within class $currentClassName is not preceded by a space or whitespace")
}
lastColumn = e.lastColumnNumber
}
}
super.visitListExpression(listExpression)
}
@Override
void visitMapExpression(MapExpression mapExpression) {
if (isFirstVisit(mapExpression)) {
def lastColumn
mapExpression.mapEntryExpressions.each { e ->
if (lastColumn && e.keyExpression.columnNumber == lastColumn + 1) {
def mapEntryAsString = e.keyExpression.text + ':' + e.valueExpression.text
addViolation(mapExpression, "The map entry $mapEntryAsString within class $currentClassName is not preceded by a space or whitespace")
}
lastColumn = e.valueExpression.lastColumnNumber
}
}
super.visitMapExpression(mapExpression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceBeforeOpeningBraceRule.groovy 0000644 0001750 0001750 00000012772 12443420675 031744 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.SwitchStatement
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.MapEntryExpression
import org.codehaus.groovy.ast.ConstructorNode
import org.codehaus.groovy.ast.MethodNode
/**
* Check that there is at least one space (blank) or whitespace before each opening brace ("{").
* This checks method/class/interface declarations, as well as try/for/while/if statements.
*
* @author Chris Mair
*/
class SpaceBeforeOpeningBraceRule extends AbstractAstVisitorRule {
String name = 'SpaceBeforeOpeningBrace'
int priority = 3
Class astVisitorClass = SpaceBeforeOpeningBraceAstVisitor
boolean checkClosureMapEntryValue = true
}
class SpaceBeforeOpeningBraceAstVisitor extends AbstractSpaceAroundBraceAstVisitor {
@Override
protected void visitClassEx(ClassNode node) {
def line = sourceLineOrEmpty(node)
def indexOfBrace = line.indexOf('{')
if (indexOfBrace > 1) {
if (isNotWhitespace(line, indexOfBrace)) {
def typeName = node.isInterface() ? 'interface' : (node.isEnum() ? 'enum' : 'class')
addViolation(node, "The opening brace for $typeName $currentClassName is not preceded by a space or whitespace")
}
}
super.visitClassEx(node)
}
@Override
protected void visitMethodEx(MethodNode node) {
processMethodNode(node, 'method')
super.visitMethodEx(node)
}
@Override
void visitConstructor(ConstructorNode node) {
processMethodNode(node, 'constructor')
super.visitConstructor(node)
}
private void processMethodNode(MethodNode node, String keyword) {
if (isFirstVisit(node.code) && node.code && !AstUtil.isFromGeneratedSourceCode(node)) {
def line = sourceLineOrEmpty(node)
if (line.contains('){')) {
addOpeningBraceViolation(node, keyword)
}
}
}
@Override
void visitBlockStatement(BlockStatement block) {
if (isFirstVisit(block) && !AstUtil.isFromGeneratedSourceCode(block)) {
def line = sourceLineOrEmpty(block)
def startCol = block.columnNumber
if (isNotWhitespace(line, startCol - 1)) {
addOpeningBraceViolation(block, 'block')
}
}
super.visitBlockStatement(block)
}
@Override
void visitClosureExpression(ClosureExpression expression) {
isFirstVisit(expression.code) // Register the code block so that it will be ignored in visitBlockStatement()
if (isFirstVisit(expression)) {
if (isCharacterPrecedingClosureInvalid(expression)) {
addOpeningBraceViolation(expression, 'closure')
}
}
super.visitClosureExpression(expression)
}
@Override
void visitMapEntryExpression(MapEntryExpression expression) {
if (!rule.checkClosureMapEntryValue && expression.valueExpression instanceof ClosureExpression) {
isFirstVisit(expression.valueExpression) // Register the closure so that it will be ignored in visitClosureExpression()
}
super.visitMapEntryExpression(expression)
}
@Override
void visitSwitch(SwitchStatement statement) {
if (isFirstVisit(statement)) {
def line = sourceLineOrEmpty(statement)
if (line.contains('){')) {
addOpeningBraceViolation(statement, 'switch statement')
}
}
super.visitSwitch(statement)
}
private boolean isCharacterPrecedingClosureInvalid(ClosureExpression expression) {
String line = sourceLineOrEmpty(expression)
int investigatedIndex = expression.columnNumber - 1
return isNotWhitespace(line, investigatedIndex) && isNotOpeningParenthesis(line, investigatedIndex) &&
isNotDollarInsideGString(line, investigatedIndex)
}
private boolean isNotDollarInsideGString(String line, int index) {
if (isNotDollar(line, index)) {
return true
}
return isNotInsideGString()
}
private boolean isNotDollar(String line, int index) {
return isNotCharacter(line, '$' as char, index)
}
private boolean isNotOpeningParenthesis(String line, int index) {
return isNotCharacter(line, '(' as char, index)
}
private void addOpeningBraceViolation(ASTNode node, String keyword) {
addViolation(node, "The opening brace for the $keyword in class $currentClassName is not preceded by a space or whitespace")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAfterForRule.groovy 0000644 0001750 0001750 00000002515 12054252376 027766 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.stmt.ForStatement
/**
* Check that there is exactly one space (blank) after the for keyword and before the opening parenthesis.
*
* @author Chris Mair
*/
class SpaceAfterForRule extends AbstractAstVisitorRule {
String name = 'SpaceAfterFor'
int priority = 3
Class astVisitorClass = SpaceAfterForAstVisitor
}
class SpaceAfterForAstVisitor extends AbstractSingleSpaceAfterKeywordAstVisitor {
@Override
void visitForLoop(ForStatement forLoop) {
checkForSingleSpaceAndOpeningParenthesis(forLoop, 'for')
super.visitForLoop(forLoop)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/TrailingWhitespaceRule.groovy 0000644 0001750 0001750 00000002472 12407277244 031075 0 ustar ebourg ebourg /*
* Copyright 2014 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.formatting
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Checks that no lines of source code end with whitespace characters.
*
* @author Joe Sondow
*/
class TrailingWhitespaceRule extends AbstractRule {
String name = 'TrailingWhitespace'
int priority = 3
@Override
void applyTo(SourceCode sourceCode, List violations) {
def matcher = sourceCode.getText() =~ /[^\n]*[ \t]+\n/
while (matcher.find()) {
def lineNumber = sourceCode.getLineNumberForCharacterIndex(matcher.start())
violations.add(createViolation(lineNumber, matcher.group(), 'Line ends with whitespace characters'))
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAfterClosingBraceRule.groovy 0000644 0001750 0001750 00000013171 12461206554 031572 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.ConstructorNode
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.expr.MapEntryExpression
import org.codehaus.groovy.ast.ASTNode
/**
* Check that there is at least one space (blank) or whitespace after each closing brace ("}").
* This checks method/class/interface declarations, closure expressions and block statements.
*
* A closure expression followed by a dot operator (.), a comma, a closing parenthesis, the
* spread-dot operator (*.), a semicolon or the null-safe operator (?.) does not cause a violation.
*
* @author Chris Mair
*/
class SpaceAfterClosingBraceRule extends AbstractAstVisitorRule {
String name = 'SpaceAfterClosingBrace'
int priority = 3
Class astVisitorClass = SpaceAfterClosingBraceAstVisitor
boolean checkClosureMapEntryValue = true
}
class SpaceAfterClosingBraceAstVisitor extends AbstractSpaceAroundBraceAstVisitor {
@Override
protected void visitClassEx(ClassNode node) {
def line = lastSourceLineOrEmpty(node)
def startColumn = node.columnNumber >= 0 ? node.columnNumber : 0
def indexOfBrace = line.indexOf('}', startColumn)
if (indexOfBrace > 1) {
if (isNotWhitespace(line, indexOfBrace + 2) && isNotAllowedCharacterAfterClass(line, indexOfBrace + 2)) {
def typeName = node.isInterface() ? 'interface' : (node.isEnum() ? 'enum' : 'class')
addViolation(node, "The closing brace for $typeName $currentClassName is not followed by a space or whitespace")
}
}
super.visitClassEx(node)
}
@Override
protected void visitMethodEx(MethodNode node) {
processMethodNode(node)
super.visitMethodEx(node)
}
@Override
void visitConstructor(ConstructorNode node) {
processMethodNode(node)
super.visitConstructor(node)
}
private void processMethodNode(MethodNode node) {
if (isFirstVisit(node.code) && node.code && !AstUtil.isFromGeneratedSourceCode(node)) {
def line = lastSourceLineOrEmpty(node.code)
def lastCol = node.code.lastColumnNumber
if (line.size() >= lastCol && isNotWhitespace(line, lastCol + 1) && line[lastCol - 1] == '}' ) {
addOpeningBraceViolation(node.code, 'block')
}
}
}
@Override
void visitBlockStatement(BlockStatement block) {
if (isFirstVisit(block) && !AstUtil.isFromGeneratedSourceCode(block)) {
def startLine = sourceLineOrEmpty(block)
def line = lastSourceLineOrEmpty(block)
def lastCol = block.lastColumnNumber
def startCol = block.columnNumber
if (startLine[startCol - 1] == '{') {
int lastIndex = indexOfClosingBrace(line, lastCol)
if (isNotWhitespace(line, lastIndex + 2)) {
addOpeningBraceViolation(block, 'block')
}
}
}
super.visitBlockStatement(block)
}
@Override
void visitClosureExpression(ClosureExpression expression) {
isFirstVisit(expression.code) // Register the code block so that it will be ignored in visitBlockStatement()
if (isFirstVisit(expression)) {
String line = lastSourceLineOrEmpty(expression)
int lastCol = expression.lastColumnNumber
int investigatedIndex = indexOfClosingBrace(line, lastCol) + 2
if (isNotWhitespace(line, investigatedIndex) &&
isNotAllowedCharacterAfterClosure(line, investigatedIndex) &&
isNotInsideGString()) {
addOpeningBraceViolation(expression, 'closure')
}
}
super.visitClosureExpression(expression)
}
@Override
void visitMapEntryExpression(MapEntryExpression expression) {
if (!rule.checkClosureMapEntryValue && expression.valueExpression instanceof ClosureExpression) {
isFirstVisit(expression.valueExpression) // Register the closure so that it will be ignored in visitClosureExpression()
}
super.visitMapEntryExpression(expression)
}
private boolean isNotAllowedCharacterAfterClosure(String line, int index) {
return index in 1..line.size() && !(line[index - 1] in ['.', ',', ')', '*', '?', ';'])
}
private boolean isNotAllowedCharacterAfterClass(String line, int index) {
return index in 1..line.size() && !(line[index - 1] in ['.', ')', ';'])
}
private void addOpeningBraceViolation(ASTNode node, String keyword) {
addViolation(node, "The closing brace for the $keyword in class $currentClassName is not followed by a space or whitespace")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/formatting/SpaceAroundOperatorRule.groovy 0000644 0001750 0001750 00000017666 12325341275 031235 0 ustar ebourg ebourg /*
* Copyright 2012 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.formatting
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.CastExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.expr.TernaryExpression
import org.codehaus.groovy.ast.expr.ElvisOperatorExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codehaus.groovy.ast.expr.DeclarationExpression
import org.codehaus.groovy.ast.expr.BooleanExpression
/**
* Check that there is at least one space (blank) or whitespace around each binary operator,
* including: +, -, *, /, >>, <<, &&, ||, &, |, ?:, =, as.
*
* Do not check dot ('.') operator. Do not check unary operators (!, +, -, ++, --, ?.).
* Do not check array ('[') operator.
*
* Known limitation: Does not catch violations of missing space around equals operator (=) within a
* declaration expression, e.g. def x=23
*
* Known limitation: Does not catch violations of certain ternary expressions.
*
* @author Chris Mair
*/
class SpaceAroundOperatorRule extends AbstractAstVisitorRule {
String name = 'SpaceAroundOperator'
int priority = 3
Class astVisitorClass = SpaceAroundOperatorAstVisitor
}
class SpaceAroundOperatorAstVisitor extends AbstractAstVisitor {
private boolean withinDeclarationExpression
@Override
void visitDeclarationExpression(DeclarationExpression expression) {
withinDeclarationExpression = true
super.visitDeclarationExpression(expression)
withinDeclarationExpression = false
}
@Override
void visitTernaryExpression(TernaryExpression expression) {
if (isFirstVisit(expression)) {
if (expression instanceof ElvisOperatorExpression) {
processElvisExpression(expression)
}
else {
processTernaryExpression(expression)
}
}
super.visitTernaryExpression(expression)
}
private void processTernaryExpression(TernaryExpression expression) {
def opColumn = expression.columnNumber
def line = sourceLine(expression)
def beforeChar = line[opColumn - 2] as char
// Known limitation: Ternary expression column does not always indicate column of '?'
if (opColumn <= leftMostColumn(expression.booleanExpression)) {
checkForSpaceAroundTernaryOperator(expression, line)
return
}
if (!Character.isWhitespace(beforeChar)) {
addViolation(expression, "The operator \"?\" within class $currentClassName is not preceded by a space or whitespace")
}
if (opColumn < line.size() && !Character.isWhitespace(line[opColumn] as char)) {
addViolation(expression, "The operator \"?\" within class $currentClassName is not followed by a space or whitespace")
}
if (rightMostColumn(expression.trueExpression) + 1 == leftMostColumn(expression.falseExpression)) {
addViolation(expression, "The operator \":\" within class $currentClassName is not surrounded by a space or whitespace")
}
}
private checkForSpaceAroundTernaryOperator(TernaryExpression expression, String line) {
if (expression.lineNumber == expression.lastLineNumber) {
def hasWhitespaceAroundQuestionMark = (line =~ /\s\?\s/)
if (!hasWhitespaceAroundQuestionMark) {
addViolation(expression, "The operator \"?\" within class $currentClassName is not surrounded by a space or whitespace")
}
def hasWhitespaceAroundColon = (line =~ /\s\:\s/)
if (!hasWhitespaceAroundColon) {
addViolation(expression, "The operator \":\" within class $currentClassName is not surrounded by a space or whitespace")
}
}
}
private void processElvisExpression(ElvisOperatorExpression expression) {
def line = sourceCode.lines[expression.lineNumber - 1]
if (line.contains('?:')) {
if (!(line =~ /\s\?\:/)) {
addViolation(expression, "The operator \"?:\" within class $currentClassName is not preceded by a space or whitespace")
}
if (!(line =~ /\?\:\s/)) {
addViolation(expression, "The operator \"?:\" within class $currentClassName is not followed by a space or whitespace")
}
}
}
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (!isFirstVisit(expression)) {
return
}
def op = expression.operation
def opText = op.text
def opEndColumn = op.startColumn + opText.size() - 1
def line = sourceCode.lines[op.startLine - 1]
boolean assignmentWithinDeclaration = (opText == '=') && withinDeclarationExpression
boolean arrayOperator = opText == '['
boolean isOperatorAtIndex = op.startColumn != -1 && (line[op.startColumn - 1] == opText[0])
boolean ignore = assignmentWithinDeclaration || arrayOperator || !isOperatorAtIndex
if (!ignore && op.startColumn > 1) {
def beforeChar = line[op.startColumn - 2] as char
if (!Character.isWhitespace(beforeChar)) {
addViolation(expression, "The operator \"${expression.operation.text}\" within class $currentClassName is not preceded by a space or whitespace")
}
}
if (!ignore && opEndColumn != -1 && opEndColumn < line.size()) {
def afterChar = line[opEndColumn] as char
if (!Character.isWhitespace(afterChar)) {
addViolation(expression, "The operator \"${expression.operation.text}\" within class $currentClassName is not followed by a space or whitespace")
}
}
super.visitBinaryExpression(expression)
}
@Override
void visitCastExpression(CastExpression expression) {
if (expression.coerce && expression.lineNumber != -1) {
boolean containsAsWithSpaces = (expression.lineNumber..expression.lastLineNumber).find { lineNumber ->
String line = sourceCode.lines[lineNumber - 1]
return line.find(/\sas\s/)
}
if (!containsAsWithSpaces) {
addViolation(expression, "The operator \"as\" within class $currentClassName is not surrounded by a space or whitespace")
}
}
super.visitCastExpression(expression)
}
private int rightMostColumn(expression) {
if (expression instanceof BinaryExpression) {
return rightMostColumn(expression.rightExpression)
}
if (expression instanceof MethodCallExpression) {
return expression.arguments.lastColumnNumber
}
if (expression instanceof PropertyExpression) {
return expression.property.lastColumnNumber
}
if (expression instanceof BooleanExpression) {
return rightMostColumn(expression.expression)
}
expression.lastColumnNumber
}
private int leftMostColumn(expression) {
return expression instanceof BinaryExpression ? leftMostColumn(expression.leftExpression) : expression.columnNumber
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/Violation.groovy 0000644 0001750 0001750 00000001735 12311373552 024243 0 ustar ebourg ebourg /*
* Copyright 2008 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
/**
* Represents a single instance of a rule violation
*
* @author Chris Mair
*/
class Violation {
Rule rule
Integer lineNumber
String sourceLine
String message
String toString() {
"Violation[rule=$rule, lineNumber=$lineNumber, sourceLine=$sourceLine, message=$message]"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/ 0000755 0001750 0001750 00000000000 12623571301 022151 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/SpockIgnoreRestUsedRule.groovy 0000644 0001750 0001750 00000004431 12407347720 030162 0 ustar ebourg ebourg /*
* Copyright 2011 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.junit
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.WildcardPattern
/**
* If Spock's @IgnoreRest on any method, all non-annotated test methods are not executed. This behaviour is almost always
* unintended. It's fine to use @IgnoreRest locally during development, but when committing code, it should be removed.
*
* @author Jan Ahrens
* @author Stefan Armbruster
* @author Chris Mair
*/
class SpockIgnoreRestUsedRule extends AbstractAstVisitorRule {
String name = 'SpockIgnoreRestUsed'
int priority = 2
String specificationSuperclassNames = '*Specification'
String specificationClassNames = null
Class astVisitorClass = SpockIgnoreRestUsedAstVisitor
}
class SpockIgnoreRestUsedAstVisitor extends AbstractMethodVisitor {
@Override
void visitClass(ClassNode node) {
def superClassPattern = new WildcardPattern(rule.specificationSuperclassNames)
def classNamePattern = new WildcardPattern(rule.specificationClassNames, false)
if (superClassPattern.matches(node.superClass.name) || classNamePattern.matches(node.name)) {
super.visitClass(node)
}
}
@Override
void visitMethod(MethodNode node) {
def hasIgnoreRest = node.annotations.any {
it.classNode.nameWithoutPackage == 'IgnoreRest'
}
if (hasIgnoreRest) {
addViolation(node, "The method '$node.name' in class $node.declaringClass.name uses @IgnoreRest")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitLostTestRule.groovy 0000644 0001750 0001750 00000005005 12311373552 027005 0 ustar ebourg ebourg /*
* Copyright 2012 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.junit
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codehaus.groovy.ast.MethodNode
import java.lang.reflect.Modifier
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.ClassNode
/**
* Rule that checks if a JUnit 4 test class contains public, instance, void, no-arg methods
* named test*() that are NOT annotated with @Test.
*
* This rule sets the default value of applyToFilesMatching to only match source code file
* paths ending in 'Test.groovy' or 'Tests.groovy'.
*
* @author Chris Mair
*/
class JUnitLostTestRule extends AbstractAstVisitorRule {
String name = 'JUnitLostTest'
int priority = 2
Class astVisitorClass = JUnitLostTestAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitLostTestAstVisitor extends AbstractMethodVisitor {
@Override
void visitClass(ClassNode node) {
def imports = sourceCode.ast.imports + sourceCode.ast.starImports
def junit4TestClass = imports.find { importNode ->
def importName = importNode.className ?: importNode.packageName
importName.startsWith('org.junit.')
}
if (junit4TestClass) {
super.visitClass(node)
}
}
@Override
void visitMethod(MethodNode methodNode) {
if (Modifier.isPublic(methodNode.modifiers)
&& (methodNode.isVoidMethod())
&& (methodNode.parameters?.length == 0)
&& (methodNode.name?.startsWith('test'))
&& !(Modifier.isStatic(methodNode.modifiers))
&& !AstUtil.hasAnnotation(methodNode, 'Test') ) {
addViolation(methodNode, "The method ${methodNode.name} is a public, instance, void, no-arg method named test*() that is not annotated with @Test.")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/CoupledTestCaseRule.groovy 0000644 0001750 0001750 00000005047 12311373552 027307 0 ustar ebourg ebourg /*
* Copyright 2011 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.junit
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* This rule finds test cases that are coupled to other test cases, either by invoking static methods on another test
* case or by creating instances of another test case. If you require shared logic in test cases then extract that logic
* to a new class where it can properly be reused. Static references to methods on the current test class are ignored.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class CoupledTestCaseRule extends AbstractAstVisitorRule {
String name = 'CoupledTestCase'
int priority = 2
Class astVisitorClass = CoupledTestCaseAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class CoupledTestCaseAstVisitor extends AbstractAstVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, '[A-Z].*Test', '.*') && !isMethodCallOnSameClass(call)) {
addViolation(call, "$call.text invokes a method on another test case. Test cases should not be coupled. Move this method to a helper object")
}
super.visitMethodCallExpression(call)
}
@Override
void visitConstructorCallExpression(ConstructorCallExpression call) {
if (call.type.name.matches('[A-Z].*Test')) {
addViolation(call, "$call.text creates an instance of a test case. Test cases should not be coupled. Move this method to a helper object")
}
super.visitConstructorCallExpression(call)
}
private boolean isMethodCallOnSameClass(MethodCallExpression call) {
AstUtil.isMethodCallOnObject(call, getCurrentClassName()) ||
AstUtil.isMethodCallOnObject(call, getCurrentClassNode().nameWithoutPackage)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitFailWithoutMessageRule.groovy 0000644 0001750 0001750 00000003131 12006632012 030754 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* This rule detects JUnit calling the fail() method without an argument. For better error reporting you should always provide a message.
*
* @author Hamlet D'Arcy
*/
class JUnitFailWithoutMessageRule extends AbstractAstVisitorRule {
String name = 'JUnitFailWithoutMessage'
int priority = 2
Class astVisitorClass = JUnitFailWithoutMessageRuleAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitFailWithoutMessageRuleAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, ['this', 'Assert'], ['fail'], 0)) {
addViolation call, 'Pass a String parameter to the fail method'
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/UseAssertSameInsteadOfAssertTrueRule.groovy 0000644 0001750 0001750 00000004133 12053435560 032617 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* This rule detects JUnit calling assertTrue where the first or second parameter is an Object#is() call testing for reference equality. These assertion should be made against the assertSame method instead.
*
* @author Hamlet D'Arcy
*/
class UseAssertSameInsteadOfAssertTrueRule extends AbstractAstVisitorRule {
String name = 'UseAssertSameInsteadOfAssertTrue'
int priority = 3
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
Class astVisitorClass = UseAssertSameInsteadOfAssertTrueAstVisitor
}
class UseAssertSameInsteadOfAssertTrueAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
List args = AstUtil.getMethodArguments(call)
if (AstUtil.isMethodCall(call, ['this', 'Assert'], ['assertTrue', 'assertFalse'])) {
if (args.size() == 1 && AstUtil.isMethodCall(args[0], 'is', 1)) {
addViolation call, 'assert method can be simplified using the assertSame method'
} else if (args.size() == 2 && AstUtil.isMethodCall(args[1], 'is', 1)) {
addViolation call, 'assert method can be simplified using the assertSame method'
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitUnnecessaryTearDownRule.groovy 0000644 0001750 0001750 00000003570 12311373552 031174 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
/**
* Rule that checks for a JUnit tearDown() method that only contains a call to
* super.tearDown().
*
* This rule sets the default value of applyToFilesMatching to only match source code file
* paths ending in 'Test.groovy' or 'Tests.groovy'.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class JUnitUnnecessaryTearDownRule extends AbstractAstVisitorRule {
String name = 'JUnitUnnecessaryTearDown'
int priority = 3
Class astVisitorClass = JUnitUnnecessaryTearDownAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitUnnecessaryTearDownAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode methodNode) {
if (JUnitUtil.isTearDownMethod(methodNode)) {
def statements = methodNode.code.statements
if (statements.size() == 1 && AstUtil.isMethodCall(statements[0], 'super', 'tearDown', 0)) {
addViolation(methodNode, 'The tearDown() method contains no logic and can be removed')
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitUnnecessaryThrowsExceptionRule.groovy 0000644 0001750 0001750 00000004522 12056263614 032617 0 ustar ebourg ebourg /*
* Copyright 2012 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.junit
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.util.AstUtil
/**
* Check for throws clauses on JUnit test methods. That is not necessary in Groovy.
*
* This rule sets the default value of the property to only match class names
* ending in 'Test', 'Tests' or 'TestCase'.
*
* @author Chris Mair
*/
class JUnitUnnecessaryThrowsExceptionRule extends AbstractAstVisitorRule {
String name = 'JUnitUnnecessaryThrowsException'
int priority = 3
Class astVisitorClass = JUnitUnnecessaryThrowsExceptionAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitUnnecessaryThrowsExceptionAstVisitor extends AbstractAstVisitor {
private static final JUNIT4_ANNOTATIONS = ['Test', 'Before', 'BeforeClass', 'AfterClass', 'After', 'Ignore']
@Override
protected void visitMethodEx(MethodNode node) {
if (node.exceptions && node.parameters.size() == 0 && node.isPublic() && !node.isStatic() && node.isVoidMethod() &&
(isJUnit3MatchingMethod(node) || hasJUnit4Annotation(node)) ) {
addViolation(node, "The ${node.name} method in class $currentClassName declares thrown exceptions, which is not necessary")
}
super.visitMethodEx(node)
}
private boolean isJUnit3MatchingMethod(MethodNode node) {
return node.name.startsWith('test') || node.name in ['setUp', 'tearDown']
}
private boolean hasJUnit4Annotation(MethodNode node) {
return JUNIT4_ANNOTATIONS.find { annotation -> AstUtil.hasAnnotation(node, annotation) }
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitAssertAlwaysFailsRule.groovy 0000644 0001750 0001750 00000005676 12311373552 030643 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
/**
* Rule that checks for JUnit assert() method calls with constant arguments
* such that the assertion always fails. This includes:
*
*
assertTrue(false).
*
assertTrue(0).
*
assertTrue('').
*
assertTrue([123]).
*
assertTrue([a:123]).
*
assertFalse(true).
*
assertFalse(99).
*
assertFalse([123]).
*
assertFalse([a:123]).
*
assertNull(CONSTANT).
*
assertNull([]).
*
assertNull([123]).
*
assertNull([a:123]).
*
assertNull([:]).
*
* This rule sets the default value of applyToFilesMatching to only match source code file
* paths ending in 'Test.groovy' or 'Tests.groovy'.
*
* @author Chris Mair
*/
class JUnitAssertAlwaysFailsRule extends AbstractAstVisitorRule {
String name = 'JUnitAssertAlwaysFails'
int priority = 2
Class astVisitorClass = JUnitAssertAlwaysFailsAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitAssertAlwaysFailsAstVisitor extends AbstractMethodCallExpressionVisitor {
void visitMethodCallExpression(MethodCallExpression methodCall) {
def isMatch =
JUnitUtil.isAssertCallWithLiteralValue(methodCall, 'assertTrue', false) ||
JUnitUtil.isAssertCallWithLiteralValue(methodCall, 'assertFalse', true) ||
JUnitUtil.isAssertCallWithNonNullConstantValue(methodCall, 'assertNull') ||
JUnitUtil.isAssertCallWithLiteralValue(methodCall, 'assertNull', true) ||
JUnitUtil.isAssertCallWithLiteralValue(methodCall, 'assertNull', false) ||
JUnitUtil.isAssertCallWithConstantValue(methodCall, 'assertNotNull', null)
if (isMatch) {
addViolation(methodCall, "The assertion $methodCall.text will always fail. Replace with a call to the fail(String) method")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/UnnecessaryFailRule.groovy 0000644 0001750 0001750 00000004343 12006632014 027341 0 ustar ebourg ebourg /*
* Copyright 2011 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.junit
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.CatchStatement
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* In a unit test, catching an exception and immedietly calling Assert.fail() is pointless and hides the stack trace. It is better to rethrow the exception or not catch the exception at all.
*
* @author Hamlet D'Arcy
*/
class UnnecessaryFailRule extends AbstractAstVisitorRule {
String name = 'UnnecessaryFail'
int priority = 2
Class astVisitorClass = UnnecessaryFailAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class UnnecessaryFailAstVisitor extends AbstractAstVisitor {
@Override
void visitCatchStatement(CatchStatement statement) {
if (statement.code instanceof BlockStatement && statement.code.statements) {
statement.code.statements.each {
addViolationIfFail(it)
}
}
super.visitCatchStatement(statement)
}
private addViolationIfFail(ASTNode it) {
if (it instanceof ExpressionStatement && it.expression instanceof MethodCallExpression) {
if (AstUtil.isMethodCall(it.expression, ['this', 'Assert'], ['fail'], 0)) {
addViolation it.expression, 'Catching an exception and failing will hide the stack trace. It is better to rethrow the exception'
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/UseAssertEqualsInsteadOfAssertTrueRule.groovy 0000644 0001750 0001750 00000004311 12006632016 033153 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* This rule detects JUnit assertions in object equality. These assertions should be made by more specific
* methods, like assertEquals.
*
* @author Per Junel
* @author Hamlet D'Arcy
*/
class UseAssertEqualsInsteadOfAssertTrueRule extends AbstractAstVisitorRule {
String name = 'UseAssertEqualsInsteadOfAssertTrue'
int priority = 3
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
Class astVisitorClass = UseAssertEqualsInsteadOfAssertTrueAstVisitor
}
class UseAssertEqualsInsteadOfAssertTrueAstVisitor extends AbstractMethodCallExpressionVisitor {
@SuppressWarnings('DuplicateLiteral')
void visitMethodCallExpression(MethodCallExpression call) {
List args = AstUtil.getMethodArguments(call)
if (args.size() < 3 && args.size() > 0) {
def arg = args.last()
if (AstUtil.isMethodCall(call, ['this', 'Assert'], ['assertTrue']) &&
AstUtil.isBinaryExpressionType(arg, '==')) {
addViolation call, "Replace $call.methodAsString with a call to assertEquals()"
}
if (AstUtil.isMethodCall(call, ['this', 'Assert'], ['assertFalse']) &&
AstUtil.isBinaryExpressionType(arg, '!=') && call.methodAsString == 'assertFalse') {
addViolation call, "Replace $call.methodAsString with a call to assertEquals()"
}
}
}
}
././@LongLink 0000644 0000000 0000000 00000000146 00000000000 011604 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitAssertEqualsConstantActualValueRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitAssertEqualsConstantActualValueRule.groov0000644 0001750 0001750 00000007555 12142570714 033325 0 ustar ebourg ebourg /*
* Copyright 2013 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.junit
import org.codehaus.groovy.ast.ClassHelper
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.StaticMethodCallExpression
import org.codehaus.groovy.control.Phases
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.junit.Assert
/**
* Reports usages of org.junit.Assert.assertEquals([message,] expected, actual) where the 'actual' parameter
* is a constant or a literal. Most likely it was intended to be the 'expected' value.
*
* @author Artur Gajowy
*/
class JUnitAssertEqualsConstantActualValueRule extends AbstractAstVisitorRule {
String name = 'JUnitAssertEqualsConstantActualValue'
int priority = 2
Class astVisitorClass = JUnitAssertEqualsConstantActualValueAstVisitor
String applyToFilesMatching = DEFAULT_TEST_FILES
int compilerPhase = Phases.SEMANTIC_ANALYSIS
}
class JUnitAssertEqualsConstantActualValueAstVisitor extends AbstractAstVisitor {
private static final ClassNode ASSERT_TYPE = ClassHelper.make(Assert)
private static final String ASSERT_EQUALS = 'assertEquals'
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (call.objectExpression.type == ASSERT_TYPE && AstUtil.isMethodNamed(call, ASSERT_EQUALS)) {
findViolations(call)
}
}
@Override
void visitStaticMethodCallExpression(StaticMethodCallExpression call) {
if (call.ownerType == ASSERT_TYPE && call.method == ASSERT_EQUALS) {
findViolations(call)
}
}
private void findViolations(def methodCall) {
Expression actualArgument = getActualArgument(methodCall)
if (actualArgument && AstUtil.isConstantOrConstantLiteral(actualArgument)) {
addViolation(methodCall, VIOLATION_MESSAGE)
}
}
private Expression getActualArgument(def methodCall) {
List arguments = AstUtil.getMethodArguments(methodCall)
int actualArgumentIndex = getActualArgumentIndex(arguments)
return actualArgumentIndex == -1 ? null : arguments[actualArgumentIndex]
}
//see org.junit.Assert.assertEquals methods' signatures
private int getActualArgumentIndex(List arguments) {
def actualArgumentIndex = -1
if (arguments.size() == 2) {
actualArgumentIndex = 1
} else if (arguments.size() == 4) {
actualArgumentIndex = 2
} else if (arguments.size() == 3) {
if (arguments.first().type == ClassHelper.make(String)) {
actualArgumentIndex = 2
} else if (isConvertibleToDouble(arguments.first().type)) {
actualArgumentIndex = 1
}
}
actualArgumentIndex
}
private boolean isConvertibleToDouble(ClassNode classNode) {
return classNode.typeClass in [int, Integer, long, Long, float, Float, double, Double, BigInteger, BigDecimal]
}
private static final String VIOLATION_MESSAGE = 'Found `assertEquals` with literal or constant `actual` parameter. ' +
'Most likely it was intended to be the `expected` value.'
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitPublicFieldRule.groovy 0000644 0001750 0001750 00000003601 12251104076 027402 0 ustar ebourg ebourg /*
* Copyright 2013 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.junit
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
/**
* Checks for public field on a JUnit test class. Ignores fields with the @Rule annotation.
*
* This rule ignores interfaces.
*
* This rule sets the default value of applyToFilesMatching to only match source code file
* paths ending in 'Test.groovy' or 'Tests.groovy'.
*
* @author Chris Mair
*/
class JUnitPublicFieldRule extends AbstractAstVisitorRule {
String name = 'JUnitPublicField'
int priority = 3
Class astVisitorClass = JUnitPublicFieldAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitPublicFieldAstVisitor extends AbstractFieldVisitor {
@Override
void visitClass(ClassNode node) {
if (!node.isInterface()) {
super.visitClass(node)
}
}
@Override
void visitField(FieldNode node) {
if (node.isPublic() && !AstUtil.hasAnnotation(node, 'Rule') ) {
addViolation(node, "The field $node.name is public. There is usually no reason to have a public field (even a constant) on a test class.")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitUnnecessarySetUpRule.groovy 0000644 0001750 0001750 00000003536 12311373552 030513 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
/**
* Rule that checks for a JUnit setUp() method that only contains a call to
* super.setUp().
*
* This rule sets the default value of applyToFilesMatching to only match source code file
* paths ending in 'Test.groovy' or 'Tests.groovy'.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class JUnitUnnecessarySetUpRule extends AbstractAstVisitorRule {
String name = 'JUnitUnnecessarySetUp'
int priority = 3
Class astVisitorClass = JUnitUnnecessarySetUpAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitUnnecessarySetUpAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode methodNode) {
if (JUnitUtil.isSetUpMethod(methodNode)) {
def statements = methodNode.code.statements
if (statements.size() == 1 && AstUtil.isMethodCall(statements[0], 'super', 'setUp', 0)) {
addViolation(methodNode, 'The setUp() method contains no logic and can be removed')
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitAssertAlwaysSucceedsRule.groovy 0000644 0001750 0001750 00000005451 12311373552 031332 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
/**
* Rule that checks for JUnit assert() method calls with constant arguments
* such that the assertion always succeeds. This includes:
*
*
assertTrue(true).
*
assertTrue('abc').
*
assertTrue(99).
*
assertTrue([123]).
*
assertTrue([a:123]).
*
assertFalse(false).
*
assertFalse(0).
*
assertFalse('').
*
assertFalse([]).
*
assertFalse([:]).
*
assertNull(null).
*
* This rule sets the default value of applyToFilesMatching to only match source code file
* paths ending in 'Test.groovy' or 'Tests.groovy'.
*
* @author Chris Mair
*/
class JUnitAssertAlwaysSucceedsRule extends AbstractAstVisitorRule {
String name = 'JUnitAssertAlwaysSucceeds'
int priority = 2
Class astVisitorClass = JUnitAssertAlwaysSucceedsAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitAssertAlwaysSucceedsAstVisitor extends AbstractMethodCallExpressionVisitor {
void visitMethodCallExpression(MethodCallExpression methodCall) {
def isMatch =
JUnitUtil.isAssertCallWithLiteralValue(methodCall, 'assertTrue', true) ||
JUnitUtil.isAssertCallWithLiteralValue(methodCall, 'assertFalse', false) ||
JUnitUtil.isAssertCallWithConstantValue(methodCall, 'assertNull', null) ||
JUnitUtil.isAssertCallWithNonNullConstantValue(methodCall, 'assertNotNull') ||
JUnitUtil.isAssertCallWithLiteralValue(methodCall, 'assertNotNull', true) ||
JUnitUtil.isAssertCallWithLiteralValue(methodCall, 'assertNotNull', false)
if (isMatch) {
addViolation(methodCall, "The assertion $methodCall.text will always pass and is therefore pointless")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitTestMethodWithoutAssertRule.groovy 0000644 0001750 0001750 00000010257 12443420675 032064 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.stmt.AssertStatement
import org.codehaus.groovy.ast.stmt.Statement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.rule.AstVisitor
import org.codenarc.util.AstUtil
/**
* This rule searches for test methods that do not contain assert statements. Either the test method is missing assert
* statements, which is an error, or the test method contains custom assert statements that do not follow a proper
* assert naming convention. Test methods are defined as public void methods that begin with the work test or have a @Test
* annotation. By default this rule applies to the default test class names, but this can be changed using the rule's
* applyToClassNames property.
*
* @author Hamlet D'Arcy
*/
class JUnitTestMethodWithoutAssertRule extends AbstractAstVisitorRule {
String name = 'JUnitTestMethodWithoutAssert'
int priority = 2
String assertMethodPatterns = 'assert.*,should.*,fail.*,verify.*,expect.*'
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
@Override
AstVisitor getAstVisitor() {
def strings = assertMethodPatterns ? assertMethodPatterns.tokenize(',') : []
new JUnitTestMethodWithoutAssertAstVisitor(assertMethodPatterns: strings as Set)
}
}
class JUnitTestMethodWithoutAssertAstVisitor extends AbstractMethodVisitor {
Set assertMethodPatterns
@Override
void visitMethod(MethodNode node) {
if (JUnitUtil.isTestMethod(node)) {
if (!statementContainsAssertions(node.code) && !checksException(node) && !checksTimeout(node)) {
addViolation node, "Test method '$node.name' makes no assertions"
}
}
}
private boolean statementContainsAssertions(Statement code) {
if (!code) {
return false
}
def assertionTrap = new AssertionTrap(assertMethodPatterns: assertMethodPatterns)
code.visit assertionTrap
assertionTrap.assertionFound
}
private boolean checksException(ASTNode node) {
hasTestAnnotationWithMember(node, 'expected')
}
private boolean checksTimeout(ASTNode node) {
hasTestAnnotationWithMember(node, 'timeout')
}
private boolean hasTestAnnotationWithMember(ASTNode node, String memberName) {
def testAnnotation = AstUtil.getAnnotation(node, 'Test') ?: AstUtil.getAnnotation(node, 'org.junit.Test')
testAnnotation?.getMember(memberName)
}
}
/**
* Visits code searching for assert statements or assert.* method calls.
*/
class AssertionTrap extends AbstractAstVisitor {
Set assertMethodPatterns
def assertionFound = false
@Override
void visitAssertStatement(AssertStatement statement) {
assertionFound = true
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (call.method instanceof ConstantExpression && methodNamesCountsAsAssertion(call.method.value)) {
assertionFound = true
} else {
super.visitMethodCallExpression call
}
}
private boolean methodNamesCountsAsAssertion(methodName) {
if (methodName instanceof String) {
return assertMethodPatterns.any { pattern ->
methodName.matches(pattern)
}
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitPublicNonTestMethodRule.groovy 0000644 0001750 0001750 00000006017 12311373552 031122 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* Rule that checks if a JUnit test class contains public methods other than:
*
*
Zero-argument methods with names starting with "test"
*
The setUp() and tearDown() methods
*
Methods annotated with @Test
*
Methods annotated with @Before and @After
*
Methods annotated with @BeforeClass and @AfterClass
*
* Public, non-test methods on a test class violate conventional usage of test classes,
* and can be confusing.
*
* Public, non-test methods may also hide unintentional 'Lost Tests'. For instance, the test method
* declaration may accidentally include methods parameters, and thus be ignored by JUnit. Or the
* method may accidentally not follow the "test.." naming convention and not have the @Test annotation,
* and thus be ignored by JUnit.
*
* This rule sets the default value of the property to only match class names
* ending in 'Test', 'Tests' or 'TestCase'.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class JUnitPublicNonTestMethodRule extends AbstractAstVisitorRule {
String name = 'JUnitPublicNonTestMethod'
int priority = 2
Class astVisitorClass = JUnitPublicNonTestMethodAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitPublicNonTestMethodAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode methodNode) {
if (Modifier.isPublic(methodNode.modifiers)
&& !(Modifier.isStatic(methodNode.modifiers))
&& !JUnitUtil.isTestMethod(methodNode)
&& !AstUtil.isMethodNode(methodNode, 'setUp|tearDown', 0)
&& !AstUtil.getAnnotation(methodNode, 'Override')
&& !AstUtil.getAnnotation(methodNode, 'Test')
&& !AstUtil.getAnnotation(methodNode, 'Before')
&& !AstUtil.getAnnotation(methodNode, 'After')
&& !AstUtil.getAnnotation(methodNode, 'BeforeClass')
&& !AstUtil.getAnnotation(methodNode, 'AfterClass') ) {
addViolation(methodNode, "The method $methodNode.name is public but not a test method")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitStyleAssertionsRule.groovy 0000644 0001750 0001750 00000004136 12006632016 030375 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* This rule detects calling JUnit style assertions like assertEquals, assertTrue, assertFalse, assertNull,
* assertNotNull. Groovy 1.7 ships with a feature called the "power assert", which is an assert statement with
* better error reporting. This is preferable to the JUnit assertions.
*
* @author Hamlet D'Arcy
*/
class JUnitStyleAssertionsRule extends AbstractAstVisitorRule {
String name = 'JUnitStyleAssertions'
int priority = 3
Class astVisitorClass = JUnitStyleAssertionsAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitStyleAssertionsAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
// TODO better suggestions
def objects = ['Assert', 'this']
(1..2).each {
if (AstUtil.isMethodCall(call, objects, ['assertTrue', 'assertFalse', 'assertNull', 'assertNotNull'], it)) {
addViolation call, "Replace $call.methodAsString with an assert statement"
}
}
(2..3).each {
if (AstUtil.isMethodCall(call, objects, ['assertEquals'], it)) {
addViolation call, "Replace $call.methodAsString with an assert statement"
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/UseAssertTrueInsteadOfNegationRule.groovy 0000644 0001750 0001750 00000004272 12006632014 032307 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.NotExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* In unit tests, if a condition is expected to be true then there is no sense using assertFalse with the negation operator. For instance, assertFalse(!condition) can always be simplified to assertTrue(condition)
*
* @author 'Hamlet D'Arcy'
*/
class UseAssertTrueInsteadOfNegationRule extends AbstractAstVisitorRule {
String name = 'UseAssertTrueInsteadOfNegation'
int priority = 2
Class astVisitorClass = UseAssertTrueInsteadOfNegationAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class UseAssertTrueInsteadOfNegationAstVisitor extends AbstractMethodCallExpressionVisitor {
@SuppressWarnings('DuplicateLiteral')
void visitMethodCallExpression(MethodCallExpression call) {
List args = AstUtil.getMethodArguments(call)
if (AstUtil.isMethodCall(call, ['this', 'Assert'], ['assertFalse'])) {
if (args.size() < 3 && args.size() > 0) {
def arg = args.last()
if (arg instanceof NotExpression) {
def left = call.objectExpression.text == 'this' ? '' : call.objectExpression.text + '.'
def right = arg.expression.text
addViolation call, "${left}assertFalse(!${right}) can be simplified to ${left}assertTrue($right)"
}
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitPublicPropertyRule.groovy 0000644 0001750 0001750 00000003470 12323246316 030213 0 ustar ebourg ebourg /*
* Copyright 2014 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.junit
import org.codehaus.groovy.ast.PropertyNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.WildcardPattern
/**
* Checks for public properties defined on JUnit test classes. There should typically be no need to
* expose a public property on a test class.
*
* @author Chris Mair
*/
class JUnitPublicPropertyRule extends AbstractAstVisitorRule {
String name = 'JUnitPublicProperty'
int priority = 2
Class astVisitorClass = JUnitPublicPropertyAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
String ignorePropertyNames
}
class JUnitPublicPropertyAstVisitor extends AbstractAstVisitor {
@Override
void visitProperty(PropertyNode node) {
if (!isIgnoredPropertyName(node)) {
addViolation(node, "The test class $currentClassName contains a public property ${node.name}. There is usually no reason to have a public property (even a constant) on a test class.")
}
super.visitProperty(node)
}
private boolean isIgnoredPropertyName(PropertyNode node) {
new WildcardPattern(rule.ignorePropertyNames, false).matches(node.name)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/ChainedTestRule.groovy 0000644 0001750 0001750 00000003240 12006632016 026436 0 ustar ebourg ebourg /*
* Copyright 2011 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* A test method that invokes another test method is a chained test; the methods are dependent on one another. Tests should be atomic, and not be dependent on one another.
*
* @author Hamlet D'Arcy
*/
class ChainedTestRule extends AbstractAstVisitorRule {
String name = 'ChainedTest'
int priority = 2
Class astVisitorClass = ChainedTestAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class ChainedTestAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, 'this', 'test.*', 0)) {
addViolation(call, "The test method $call.methodAsString() is being invoked explicitly from within a unit test. Tests should be isolated and not dependent on one another")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/UseAssertNullInsteadOfAssertEqualsRule.groovy 0000644 0001750 0001750 00000003754 12006632012 033154 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* This rule detects JUnit calling assertEquals where the first or second parameter is null. These assertion should be made against the assertNull method instead.
*
* @author Hamlet D'Arcy
*/
class UseAssertNullInsteadOfAssertEqualsRule extends AbstractAstVisitorRule {
String name = 'UseAssertNullInsteadOfAssertEquals'
int priority = 3
Class astVisitorClass = UseAssertNullInsteadOfAssertEqualsAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class UseAssertNullInsteadOfAssertEqualsAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
List args = AstUtil.getMethodArguments(call)
if (AstUtil.isMethodCall(call, 'this', 'assertEquals')) {
if (args.size() == 2 && (AstUtil.isNull(args[0]) || AstUtil.isNull(args[1]))) {
addViolation call, 'assertEquals can be simplified using assertNull'
} else if (args.size() == 3 && (AstUtil.isNull(args[1]) || AstUtil.isNull(args[2]))) {
addViolation call, 'assertEquals can be simplified using assertNull'
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitSetUpCallsSuperRule.groovy 0000644 0001750 0001750 00000003624 12311373552 030267 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
/**
* Rule that checks that if the JUnit setUp() method is defined, that it includes a call to
* super.setUp().
*
* This rule sets the default value of applyToFilesMatching to only match source code file
* paths ending in 'Test.groovy' or 'Tests.groovy'.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class JUnitSetUpCallsSuperRule extends AbstractAstVisitorRule {
String name = 'JUnitSetUpCallsSuper'
int priority = 2
Class astVisitorClass = JUnitSetUpCallsSuperAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitSetUpCallsSuperAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode methodNode) {
if (JUnitUtil.isSetUpMethod(methodNode)) {
def statements = methodNode.code.statements
def found = statements.find { stmt ->
AstUtil.isMethodCall(stmt, 'super', 'setUp', 0)
}
if (!found) {
addViolation(methodNode, 'The method setUp() does not call super.setUp()')
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/UseAssertFalseInsteadOfNegationRule.groovy 0000644 0001750 0001750 00000004273 12006632012 032421 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.NotExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* In unit tests, if a condition is expected to be false then there is no sense using assertTrue with the negation operator. For instance, assertTrue(!condition) can always be simplified to assertFalse(condition)
*
* @author Hamlet D'Arcy
*/
class UseAssertFalseInsteadOfNegationRule extends AbstractAstVisitorRule {
String name = 'UseAssertFalseInsteadOfNegation'
int priority = 2
Class astVisitorClass = UseAssertFalseInsteadOfNegationAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class UseAssertFalseInsteadOfNegationAstVisitor extends AbstractMethodCallExpressionVisitor {
@SuppressWarnings('DuplicateLiteral')
void visitMethodCallExpression(MethodCallExpression call) {
List args = AstUtil.getMethodArguments(call)
if (AstUtil.isMethodCall(call, ['this', 'Assert'], ['assertTrue'])) {
if (args.size() < 3 && args.size() > 0) {
def arg = args.last()
if (arg instanceof NotExpression) {
def left = call.objectExpression.text == 'this' ? '' : call.objectExpression.text + '.'
def right = arg.expression.text
addViolation call, "${left}assertTrue(!${right}) can be simplified to ${left}assertFalse($right)"
}
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/UseAssertTrueInsteadOfAssertEqualsRule.groovy 0000644 0001750 0001750 00000006545 12467726544 033213 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.stmt.AssertStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* This rule detects JUnit calling assertEquals where the first parameter is a boolean. These assertions
* should be made by more specific methods, like assertTrue or assertFalse.
*
* If the checkAssertStatements property is true, then it also checks for assert statements, e.g. assert x == true.
*
* @author Hamlet D'Arcy
*/
class UseAssertTrueInsteadOfAssertEqualsRule extends AbstractAstVisitorRule {
String name = 'UseAssertTrueInsteadOfAssertEquals'
int priority = 3
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
boolean checkAssertStatements = false
Class astVisitorClass = UseAssertTrueInsteadOfAssertEqualsAstVisitor
}
class UseAssertTrueInsteadOfAssertEqualsAstVisitor extends AbstractAstVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
List args = AstUtil.getMethodArguments(call)
if (AstUtil.isMethodCall(call, 'this', 'assertEquals')) {
if (args.size() == 2 && (AstUtil.isBoolean(args[0]) || AstUtil.isBoolean(args[1]))) {
addViolation call, 'assertEquals can be simplified using assertTrue or assertFalse'
} else if (args.size() == 3 && (AstUtil.isBoolean(args[1]) || AstUtil.isBoolean(args[2]))) {
addViolation call, 'assertEquals can be simplified using assertTrue or assertFalse'
}
}
super.visitMethodCallExpression call
}
@Override
void visitAssertStatement(AssertStatement statement) {
if (rule.checkAssertStatements && AstUtil.isBinaryExpressionType(statement.booleanExpression.expression, '==')) {
BinaryExpression exp = statement.booleanExpression.expression
if (AstUtil.isTrue(exp.leftExpression)) {
addViolation(statement, "The expression '$exp.text' can be simplified to '$exp.rightExpression.text'")
} else if (AstUtil.isTrue(exp.rightExpression)) {
addViolation(statement, "The expression '$exp.text' can be simplified to '$exp.leftExpression.text'")
} else if (AstUtil.isFalse(exp.leftExpression)) {
addViolation(statement, "The expression '$exp.text' can be simplified to '!$exp.rightExpression.text'")
} else if (AstUtil.isFalse(exp.rightExpression)) {
addViolation(statement, "The expression '$exp.text' can be simplified to '!$exp.leftExpression.text'")
}
}
super.visitAssertStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitTearDownCallsSuperRule.groovy 0000644 0001750 0001750 00000003662 12311373552 030754 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
/**
* Rule that checks that if the JUnit tearDown() method is defined, that it includes a call to
* super.tearDown().
*
* This rule sets the default value of applyToFilesMatching to only match source code file
* paths ending in 'Test.groovy' or 'Tests.groovy'.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class JUnitTearDownCallsSuperRule extends AbstractAstVisitorRule {
String name = 'JUnitTearDownCallsSuper'
int priority = 2
Class astVisitorClass = JUnitTearDownCallsSuperAstVisitor
String applyToClassNames = DEFAULT_TEST_CLASS_NAMES
}
class JUnitTearDownCallsSuperAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode methodNode) {
if (JUnitUtil.isTearDownMethod(methodNode)) {
def statements = methodNode.code.statements
def found = statements.find { stmt ->
AstUtil.isMethodCall(stmt, 'super', 'tearDown', 0)
}
if (!found) {
addViolation(methodNode, 'The method tearDown() does not call super.tearDown()')
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/junit/JUnitUtil.groovy 0000644 0001750 0001750 00000013322 12461316616 025316 0 ustar ebourg ebourg /*
* 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.junit
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.ListExpression
import org.codehaus.groovy.ast.expr.MapExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codenarc.util.AstUtil
/**
* Utility methods for JUnit rule classes. This class is not intended for general use.
*
* @author Chris Mair
*/
class JUnitUtil {
/**
* Return true if the MethodCallExpression represents a JUnit assert method call with the specified
* method name and constant argument value. This handles either single-argument assert calls or
* 2-argument assert methods where the first parameter is the assertion message.
* @param methodCall - the MethodCallExpression of the method call
* @param methodName - the name of the method
* @param value - the argument value
*/
protected static boolean isAssertCallWithConstantValue(MethodCallExpression methodCall, String methodName, Object value) {
return isAssertCallWithValueMatching(methodCall, methodName) { v -> v == value }
}
protected static boolean isAssertCallWithNonNullConstantValue(MethodCallExpression methodCall, String methodName) {
return isAssertCallWithValueMatching(methodCall, methodName) { v -> v != null }
}
private static boolean isAssertCallWithValueMatching(MethodCallExpression methodCall, String methodName, Closure closure) {
def isMatch = false
if (AstUtil.isMethodCall(methodCall, 'this', methodName)) {
def args = methodCall.arguments.expressions
def valueExpression = args.last()
isMatch = args.size() in 1..2 &&
valueExpression instanceof ConstantExpression &&
closure(valueExpression.value)
}
isMatch
}
/**
* Return true if the MethodCallExpression represents a JUnit assert method call with the specified
* method name and constant argument value. This handles either single-argument assert calls or
* 2-argument assert methods where the first parameter is the assertion message.
* @param methodCall - the MethodCallExpression of the method call
* @param methodName - the name of the method
* @param literalEvaluatesToTrue - true if the argument value must evaluate to true using Groovy truth
*/
protected static boolean isAssertCallWithLiteralValue(MethodCallExpression methodCall, String methodName, boolean literalEvaluatesToTrue) {
def isMatch = false
if (AstUtil.isMethodCall(methodCall, 'this', methodName)) {
def args = methodCall.arguments.expressions
isMatch = args.size() in 1..2 &&
isLiteralWithValueThatEvaluatesTo(args.last(), literalEvaluatesToTrue)
}
isMatch
}
private static boolean isLiteralWithValueThatEvaluatesTo(Expression expression, boolean literalEvaluatesToTrue) {
if (expression instanceof ConstantExpression) {
def value = expression.properties['value']
return value != null && (value as boolean) == literalEvaluatesToTrue
}
if (expression instanceof ListExpression) {
return expression.expressions.isEmpty() == !literalEvaluatesToTrue
}
if (expression instanceof MapExpression) {
return expression.mapEntryExpressions.isEmpty() == !literalEvaluatesToTrue
}
}
protected static boolean isSetUpMethod(MethodNode methodNode) {
(methodNode.name == 'setUp' &&
methodNode.parameters.size() == 0 &&
!AstUtil.getAnnotation(methodNode, 'Before') &&
methodNode.code instanceof BlockStatement)
}
protected static boolean isTearDownMethod(MethodNode methodNode) {
(methodNode.name == 'tearDown' &&
methodNode.parameters.size() == 0 &&
!AstUtil.getAnnotation(methodNode, 'After') &&
methodNode.code instanceof BlockStatement)
}
/**
* Tells you if an ASTNode is a test MethodNode. A method node is a MethodNode and is named test.* or is annotated
* with @Test or @org.junit.Test,
* @param node
* the node to analyze
* @return
* true if the node is a test method
*/
static boolean isTestMethod(ASTNode node) {
if (!AstUtil.isPublic(node)) {
return false
}
if (!(node instanceof MethodNode)) {
return false
}
if (!node.isVoidMethod()) {
return false
}
if (node.parameters?.length > 0) {
return false
}
if (node.name?.startsWith('test')) {
return true
}
node.properties['annotations']?.any { annotation ->
def name = annotation?.properties['classNode']?.name
name == 'Test' || name == 'org.junit.Test'
}
}
/**
* Private constructor. All members are static.
*/
private JUnitUtil() { }
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ 0000755 0001750 0001750 00000000000 12623571301 023201 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchNullPointerExceptionRule.groovy 0000644 0001750 0001750 00000002115 12006632014 032366 0 ustar ebourg ebourg /*
* Copyright 2008 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for catching a NullPointerException
*
* @author Chris Mair
*/
class CatchNullPointerExceptionRule extends AbstractAstVisitorRule {
String name = 'CatchNullPointerException'
int priority = 2
AstVisitor getAstVisitor() {
new CommonCatchAstVisitor('NullPointerException')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchIndexOutOfBoundsExceptionRule.groovy0000644 0001750 0001750 00000002141 12006632012 033307 0 ustar ebourg ebourg /*
* Copyright 2011 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for catching a IndexOutOfBoundsException
*
* @author Chris Mair
*/
class CatchIndexOutOfBoundsExceptionRule extends AbstractAstVisitorRule {
String name = 'CatchIndexOutOfBoundsException'
int priority = 2
AstVisitor getAstVisitor() {
new CommonCatchAstVisitor('IndexOutOfBoundsException')
}
}
././@LongLink 0000644 0000000 0000000 00000000152 00000000000 011601 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchArrayIndexOutOfBoundsExceptionRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchArrayIndexOutOfBoundsExceptionRule.g0000644 0001750 0001750 00000002165 12006632014 033217 0 ustar ebourg ebourg /*
* Copyright 2011 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for catching a ArrayIndexOutOfBoundsException
*
* @author Chris Mair
*/
class CatchArrayIndexOutOfBoundsExceptionRule extends AbstractAstVisitorRule {
String name = 'CatchArrayIndexOutOfBoundsException'
int priority = 2
AstVisitor getAstVisitor() {
new CommonCatchAstVisitor('ArrayIndexOutOfBoundsException')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchErrorRule.groovy 0000644 0001750 0001750 00000002021 12006632016 027323 0 ustar ebourg ebourg /*
* Copyright 2008 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for catching a Error
*
* @author Chris Mair
*/
class CatchErrorRule extends AbstractAstVisitorRule {
String name = 'CatchError'
int priority = 2
AstVisitor getAstVisitor() {
new CommonCatchAstVisitor('Error')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ThrowNullPointerExceptionRule.groovy 0000644 0001750 0001750 00000002207 12311373552 032461 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for throwing an instance of java.lang.NullPointerException
*
* @author Chris Mair
*/
class ThrowNullPointerExceptionRule extends AbstractAstVisitorRule {
String name = 'ThrowNullPointerException'
int priority = 2
AstVisitor getAstVisitor() {
new CommonThrowAstVisitor(['NullPointerException', 'java.lang.NullPointerException'])
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ExceptionExtendsThrowableRule.groovy 0000644 0001750 0001750 00000003064 12316050647 032450 0 ustar ebourg ebourg /*
* Copyright 2013 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.exceptions
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.util.AstUtil
/**
* Checks for classes that extend Throwable. Custom exception classes should subclass Exception or one of its descendants.
*
* @author Chris Mair
*/
class ExceptionExtendsThrowableRule extends AbstractAstVisitorRule {
String name = 'ExceptionExtendsThrowable'
int priority = 2
Class astVisitorClass = ExceptionExtendsThrowableAstVisitor
}
class ExceptionExtendsThrowableAstVisitor extends AbstractAstVisitor {
@Override
protected void visitClassEx(ClassNode node) {
if (AstUtil.classNodeImplementsType(node, Throwable)) {
addViolation(node, "The class $node.name extends Throwable. Custom exception classes should subclass Exception or one of its descendants.")
}
super.visitClassEx(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ConfusingClassNamedExceptionRule.groovy 0000644 0001750 0001750 00000003147 12006632012 033042 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* This rule traps classes named exception that do not inherit from exception.
*
* @author Hamlet D'Arcy
*/
class ConfusingClassNamedExceptionRule extends AbstractAstVisitorRule {
String name = 'ConfusingClassNamedException'
int priority = 2
Class astVisitorClass = ConfusingClassNamedExceptionAstVisitor
}
class ConfusingClassNamedExceptionAstVisitor extends AbstractAstVisitor {
void visitClassEx(ClassNode node) {
if (node.name.endsWith('Exception') && !AstUtil.classNodeImplementsType(node, Exception)) {
if (!(node.superClass.name == 'Throwable') && !node.superClass.name.endsWith('Exception')) {
addViolation node, "Found a class named $node.name that does not extend Exception."
}
}
super.visitClassEx(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ReturnNullFromCatchBlockRule.groovy 0000644 0001750 0001750 00000004573 12410141717 032163 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.CatchStatement
import org.codehaus.groovy.ast.stmt.ReturnStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Returning null from a catch block often masks errors and requires the client to handle error codes.
* In some coding styles this is discouraged. This rule ignores methods with void return type.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class ReturnNullFromCatchBlockRule extends AbstractAstVisitorRule {
String name = 'ReturnNullFromCatchBlock'
int priority = 2
Class astVisitorClass = ReturnNullFromCatchBlockAstVisitor
}
class ReturnNullFromCatchBlockAstVisitor extends AbstractAstVisitor {
@Override
protected boolean shouldVisitMethod(MethodNode node) {
// Ignore void methods
return node.returnType.toString() != 'void'
}
void visitCatchStatement(CatchStatement node) {
def lastStatement = getLastStatement(node)
if (lastStatement instanceof ReturnStatement) {
if (AstUtil.isNull(lastStatement.expression)) {
addViolation lastStatement, 'Do not return null from a catch block'
}
}
super.visitCatchStatement node
}
/**
* This is not a good general function for AstUtils.
* It is too specific and may not work across different ASTNode subtypes.
* @param node
* node
*/
private static getLastStatement(node) {
if (node.code instanceof BlockStatement && node.code.statements) {
return node.code.statements.last()
}
null
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CommonThrowAstVisitor.groovy 0000644 0001750 0001750 00000003627 12311373552 030766 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.stmt.ThrowStatement
import org.codenarc.rule.AbstractAstVisitor
/**
* AstVisitor implementation that checks for throwing one of the exception type names specified in the constructor
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class CommonThrowAstVisitor extends AbstractAstVisitor {
private final List exceptionTypeNames
/**
* Construct a new instance, specifying the exception type names
* @param exceptionTypeNames - the names of the exception class; typically including class name
* with and without package
*/
CommonThrowAstVisitor(List exceptionTypeNames) {
this.exceptionTypeNames = exceptionTypeNames
}
void visitThrowStatement(ThrowStatement throwStatement) {
def throwExpression = throwStatement.expression
if (isFirstVisit(throwStatement) &&
throwExpression instanceof ConstructorCallExpression &&
throwExpression.type.name in exceptionTypeNames) {
addViolation(throwStatement, "The type $throwExpression.type.name should not be thrown")
}
super.visitThrowStatement(throwStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ThrowErrorRule.groovy 0000644 0001750 0001750 00000002074 12311373552 027422 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for throwing an instance of java.lang.Error
*
* @author Chris Mair
*/
class ThrowErrorRule extends AbstractAstVisitorRule {
String name = 'ThrowError'
int priority = 2
AstVisitor getAstVisitor() {
new CommonThrowAstVisitor(['Error', 'java.lang.Error'])
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ExceptionExtendsErrorRule.groovy 0000644 0001750 0001750 00000002677 12322751146 031622 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Errors are system exceptions. Do not extend them.
*
* @author Hamlet D'Arcy
*/
class ExceptionExtendsErrorRule extends AbstractAstVisitorRule {
String name = 'ExceptionExtendsError'
int priority = 2
Class astVisitorClass = ExceptionExtendsErrorAstVisitor
}
class ExceptionExtendsErrorAstVisitor extends AbstractAstVisitor {
@Override
protected void visitClassEx(ClassNode node) {
if (AstUtil.classNodeImplementsType(node, Error)) {
addViolation(node, "The class $node.name extends Error, which is meant to be used only as a system exception")
}
super.visitClassEx(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ThrowExceptionRule.groovy 0000644 0001750 0001750 00000002120 12311373552 030257 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for throwing an instance of java.lang.Exception
*
* @author Chris Mair
*/
class ThrowExceptionRule extends AbstractAstVisitorRule {
String name = 'ThrowException'
int priority = 2
AstVisitor getAstVisitor() {
new CommonThrowAstVisitor(['Exception', 'java.lang.Exception'])
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/MissingNewInThrowStatementRule.groovy 0000644 0001750 0001750 00000005605 12047331630 032570 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.ThrowStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* A common Groovy mistake when throwing exceptions is to forget the new keyword. For instance, "throw RuntimeException()"
* instead of "throw new RuntimeException()". If the error path is not unit tested then the production system will throw
* a Method Missing exception and hide the root cause. This rule finds constructs like "throw RuntimeException()" that
* look like a new keyword was meant to be used but forgotten.
*
* @author Hamlet D'Arcy
*/
class MissingNewInThrowStatementRule extends AbstractAstVisitorRule {
String name = 'MissingNewInThrowStatement'
int priority = 2
Class astVisitorClass = MissingNewInThrowStatementAstVisitor
}
class MissingNewInThrowStatementAstVisitor extends AbstractAstVisitor {
@Override
void visitThrowStatement(ThrowStatement statement) {
if (statement.expression instanceof MethodCallExpression) {
String name = statement?.expression?.method?.properties['value']
if (looksLikeAnExceptionType(name)) {
addViolation (statement, "The throw statement appears to be throwing the class literal $name instead of a new instance")
}
} else if (statement.expression instanceof VariableExpression) {
String name = statement.expression.variable
if (looksLikeAnExceptionType(name)) {
addViolation (statement, "The throw statement appears to be throwing the class literal $name instead of a new instance")
}
}
super.visitThrowStatement(statement)
}
private static boolean looksLikeAnExceptionType(String name) {
if (isFirstLetterUpperCase(name)) {
if (name.endsWith('Exception') || name.endsWith('Failure') || name.endsWith('Fault')) {
return true
}
}
false
}
private static boolean isFirstLetterUpperCase(String name) {
return name && (name[0] as Character).isUpperCase()
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ThrowRuntimeExceptionRule.groovy 0000644 0001750 0001750 00000002163 12311373552 031632 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for throwing an instance of java.lang.RuntimeException
*
* @author Chris Mair
*/
class ThrowRuntimeExceptionRule extends AbstractAstVisitorRule {
String name = 'ThrowRuntimeException'
int priority = 2
AstVisitor getAstVisitor() {
new CommonThrowAstVisitor(['RuntimeException', 'java.lang.RuntimeException'])
}
}
././@LongLink 0000644 0000000 0000000 00000000150 00000000000 011577 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchIllegalMonitorStateExceptionRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchIllegalMonitorStateExceptionRule.gro0000644 0001750 0001750 00000002122 12006632014 033275 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule to trap when IllegalMonitorStateException is being caught.
*
* @author Hamlet D'Arcy
*/
class CatchIllegalMonitorStateExceptionRule extends AbstractAstVisitorRule {
String name = 'CatchIllegalMonitorStateException'
int priority = 2
AstVisitor getAstVisitor() {
new CommonCatchAstVisitor('IllegalMonitorStateException')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ExceptionNotThrownRule.groovy 0000644 0001750 0001750 00000004530 12060741510 031117 0 ustar ebourg ebourg /*
* Copyright 2012 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import org.codehaus.groovy.ast.stmt.CatchStatement
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.stmt.Statement
import org.codehaus.groovy.ast.stmt.ExpressionStatement
/**
* Checks for an exception constructor call as the last statement within a catch block.
*
* @author Chris Mair
*/
class ExceptionNotThrownRule extends AbstractAstVisitorRule {
String name = 'ExceptionNotThrown'
int priority = 2
Class astVisitorClass = ExceptionNotThrownAstVisitor
}
class ExceptionNotThrownAstVisitor extends AbstractAstVisitor {
@Override
void visitCatchStatement(CatchStatement statement) {
def lastStatement = getLastStatement(statement.code)
if (isLastStatementAnExceptionConstructorCall(lastStatement)) {
def typeName = lastStatement.expression.type.name
addViolation(lastStatement, "The catch statement within class $currentClassName constructs a [$typeName] but does not throw it")
}
super.visitCatchStatement(statement)
}
private Statement getLastStatement(BlockStatement block) {
return block.statements.size() > 0 ? block.statements[-1] : null
}
private boolean isLastStatementAnExceptionConstructorCall(Statement lastStatement) {
return lastStatement &&
lastStatement instanceof ExpressionStatement &&
lastStatement.expression instanceof ConstructorCallExpression &&
lastStatement.expression.type.name.endsWith('Exception')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchRuntimeExceptionRule.groovy 0000644 0001750 0001750 00000002075 12006632014 031543 0 ustar ebourg ebourg /*
* Copyright 2008 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for catching a RuntimeException
*
* @author Chris Mair
*/
class CatchRuntimeExceptionRule extends AbstractAstVisitorRule {
String name = 'CatchRuntimeException'
int priority = 2
AstVisitor getAstVisitor() {
new CommonCatchAstVisitor('RuntimeException')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchThrowableRule.groovy 0000644 0001750 0001750 00000002041 12006632014 030161 0 ustar ebourg ebourg /*
* Copyright 2008 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for catching a Throwable
*
* @author Chris Mair
*/
class CatchThrowableRule extends AbstractAstVisitorRule {
String name = 'CatchThrowable'
int priority = 2
AstVisitor getAstVisitor() {
new CommonCatchAstVisitor('Throwable')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/SwallowThreadDeathRule.groovy 0000644 0001750 0001750 00000005216 12311370173 031030 0 ustar ebourg ebourg /*
* Copyright 2011 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.exceptions
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.CatchStatement
import org.codehaus.groovy.ast.stmt.ThrowStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Detects code that catches java.lang.ThreadDeath without re-throwing it. If ThreadDeath is caught by a method, it is important that it be rethrown so that the thread actually dies.
*
* @author Rob Fletcher
* @author Klaus Baumecker
*/
class SwallowThreadDeathRule extends AbstractAstVisitorRule {
String name = 'SwallowThreadDeath'
int priority = 2
Class astVisitorClass = SwallowThreadDeathAstVisitor
}
class SwallowThreadDeathAstVisitor extends AbstractAstVisitor {
private boolean withinCatchThreadDeath = false
private String caughtVariableName = null
private boolean foundThrow = false
@Override
void visitCatchStatement(CatchStatement statement) {
if (statement.exceptionType.name == ThreadDeath.simpleName) {
withinCatchThreadDeath = true
foundThrow = false
caughtVariableName = statement.variable.name
super.visitCatchStatement(statement)
withinCatchThreadDeath = false
if (!foundThrow) {
addViolation statement, 'ThreadDeath caught without being re-thrown. If ThreadDeath is caught by a method, it is important that it be rethrown so that the thread actually dies.'
}
}
}
@Override
void visitThrowStatement(ThrowStatement statement) {
if (withinCatchThreadDeath) {
def expression = statement.expression
if (expression instanceof VariableExpression && expression.name == caughtVariableName) {
foundThrow = true
} else if (expression instanceof ConstructorCallExpression && expression.type.name == ThreadDeath.simpleName) {
foundThrow = true
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CommonCatchAstVisitor.groovy 0000644 0001750 0001750 00000003405 12311373552 030677 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codehaus.groovy.ast.stmt.CatchStatement
import org.codenarc.rule.AbstractAstVisitor
/**
* AstVisitor implementation that checks for catching an exception type specified in the constructor
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class CommonCatchAstVisitor extends AbstractAstVisitor {
private final exceptionClassNameWithoutPackage
/**
* Construct a new instance, specifying the exception class name
* @param exceptionClassNameWithoutPackage - the name of the exception class to check for, without the package
*/
CommonCatchAstVisitor(String exceptionClassNameWithoutPackage) {
this.exceptionClassNameWithoutPackage = exceptionClassNameWithoutPackage
}
void visitCatchStatement(CatchStatement catchStatement) {
if (isFirstVisit(catchStatement) && catchStatement.exceptionType.nameWithoutPackage == exceptionClassNameWithoutPackage) {
addViolation(catchStatement, "The type $exceptionClassNameWithoutPackage should not be caught")
}
super.visitCatchStatement(catchStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/CatchExceptionRule.groovy 0000644 0001750 0001750 00000002041 12006632016 030172 0 ustar ebourg ebourg /*
* Copyright 2008 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for catching a Exception
*
* @author Chris Mair
*/
class CatchExceptionRule extends AbstractAstVisitorRule {
String name = 'CatchException'
int priority = 2
AstVisitor getAstVisitor() {
new CommonCatchAstVisitor('Exception')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/exceptions/ThrowThrowableRule.groovy 0000644 0001750 0001750 00000002120 12311373552 030250 0 ustar ebourg ebourg /*
* 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.exceptions
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Rule that checks for throwing an instance of java.lang.Throwable
*
* @author Chris Mair
*/
class ThrowThrowableRule extends AbstractAstVisitorRule {
String name = 'ThrowThrowable'
int priority = 2
AstVisitor getAstVisitor() {
new CommonThrowAstVisitor(['Throwable', 'java.lang.Throwable'])
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/NullReturnTracker.groovy 0000644 0001750 0001750 00000004472 12407310774 025731 0 ustar ebourg ebourg /*
* 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
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.TernaryExpression
import org.codehaus.groovy.ast.stmt.ReturnStatement
/**
* Helper AST visitor that adds rule violation if a return statement is encountered that returns a null constant.
*
* @author Hamlet D'Arcy
*/
class NullReturnTracker extends AbstractAstVisitor {
// NOTE: The provided parent must be a subclass of AbstractAstVisitor and
// implement the void handleClosure(ClosureExpression expression) method
def parent
def errorMessage
void visitReturnStatement(ReturnStatement statement) {
def expression = statement.expression
if (expressionReturnsNull(expression)) {
parent.addViolation(statement, errorMessage)
}
super.visitReturnStatement(statement)
}
private expressionReturnsNull(Expression expression) {
def stack = [expression] as Stack // alternative to recursion
while (stack) {
def expr = stack.pop()
if (expr == ConstantExpression.NULL) {
return true
} else if (expr instanceof ConstantExpression && expr.value == null) {
return true
} else if (expr instanceof TernaryExpression) {
stack.push(expr.trueExpression)
stack.push(expr.falseExpression)
}
}
false
}
void visitClosureExpression(ClosureExpression expression) {
parent.handleClosure(expression)
// do not keep walking, let the parent start a new walk for this new scope
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/ 0000755 0001750 0001750 00000000000 12623571301 022301 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsMassAssignmentRule.groovy 0000644 0001750 0001750 00000005455 12275777054 030527 0 ustar ebourg ebourg /*
* Copyright 2013 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.grails
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codehaus.groovy.ast.expr.AttributeExpression
import org.codehaus.groovy.ast.expr.VariableExpression
/**
* Untrusted input should not be allowed to set arbitrary object fields without restriction.
*
* TODO: Switch from name-based detection to type based detection when Grails domain object interfaces are detectable
* @author Brian Soby
*/
class GrailsMassAssignmentRule extends AbstractAstVisitorRule {
String name = 'GrailsMassAssignment'
int priority = 2
Class astVisitorClass = GrailsMassAssignmentAstVisitor
}
@SuppressWarnings('NestedBlockDepth')
class GrailsMassAssignmentAstVisitor extends AbstractAstVisitor {
@Override
void visitConstructorCallExpression(ConstructorCallExpression call) {
if (isFirstVisit(call)) {
if (call.arguments && call.arguments.expressions) {
def exp = call.arguments.expressions.first()
if (exp instanceof VariableExpression) {
if (exp.variable == 'params') {
addViolation(call, 'Restrict mass attribute assignment')
}
}
}
}
super.visitConstructorCallExpression(call)
}
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (isFirstVisit(expression)) {
if (expression.leftExpression instanceof PropertyExpression && !(expression.leftExpression instanceof AttributeExpression) ) {
if (expression.leftExpression.property.hasProperty('value') && expression.leftExpression.property.value == 'properties') {
if (expression.rightExpression instanceof VariableExpression && expression.rightExpression.variable == 'params') {
addViolation(expression, 'Restrict mass attribute assignment')
}
}
}
}
super.visitBinaryExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsServletContextReferenceRule.groovy 0000644 0001750 0001750 00000005273 12465006116 032362 0 ustar ebourg ebourg /*
* 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.grails
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that checks for references to the servletContext object from within Grails controller and
* taglib classes.
*
* This rule is intended as a "governance" rule to enable monitoring and controlling access to the
* servletContext from within application source code. Storing objects in the servletContext may
* inhibit scalability and/or performance and should be carefully considered. Furthermore, access
* to the servletContext is not synchronized, so reading/writing objects from the servletConext must
* be manually synchronized, as described in The Definitive Guide to Grails (2nd edition).
*
* Enabling this rule may make most sense in a team environment where team members exhibit a broad
* range of skill and experience levels. Appropriate servletContext access can be configured as
* exceptions to this rule by configuring either the doNotApplyToFilenames or
* doNotApplyToFilesMatching property of the rule.
*
* This rule sets the default value of applyToFilesMatching to only match files
* under the 'grails-app/controllers' or 'grails-app/taglib' folders. You can override this
* with a different regular expression value if appropriate.
*
* @author Chris Mair
*/
class GrailsServletContextReferenceRule extends AbstractAstVisitorRule {
String name = 'GrailsServletContextReference'
int priority = 2
Class astVisitorClass = GrailsServletContextReferenceAstVisitor
String applyToFilesMatching = GrailsUtil.CONTROLLERS_AND_TAGLIB_FILES
}
class GrailsServletContextReferenceAstVisitor extends AbstractAstVisitor {
void visitVariableExpression(VariableExpression expression) {
if (isFirstVisit(expression) && expression.variable == 'servletContext') {
addViolation(expression, 'Storing objects in the servletContext can limit scalability')
}
super.visitVariableExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsDomainReservedSqlKeywordNameRule.groovy0000644 0001750 0001750 00000021661 12311373552 033307 0 ustar ebourg ebourg /*
* Copyright 2012 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.grails
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.ListExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* Forbids usage of SQL reserved keywords as class or field names in Grails domain classes.
* Naming a domain class (or its field) with such a keyword causes SQL schema creation errors and/or redundant
* table/column name mappings.
*
* Note: due to limited type information available during CodeNarc's operation, this rule will report fields
* of type {@link java.io.Serializable}, but not of its implementations. Please specify any implementations
* used as domain properties in {@code #additionalHibernateBasicTypes}.
*
* @author Artur Gajowy
*/
class GrailsDomainReservedSqlKeywordNameRule extends AbstractAstVisitorRule {
String name = 'GrailsDomainReservedSqlKeywordName'
int priority = 2
Class astVisitorClass = GrailsDomainReservedSqlKeywordNameAstVisitor
String applyToFilesMatching = GrailsUtil.DOMAIN_FILES
//based on http://developer.mimer.com/validator/sql-reserved-words.tml
private final reservedSqlKeywords = ['ABSOLUTE', 'ACTION', 'ADD', 'AFTER', 'ALL', 'ALLOCATE', 'ALTER', 'AND', 'ANY',
'ARE', 'ARRAY', 'AS', 'ASC', 'ASENSITIVE', 'ASSERTION', 'ASYMMETRIC', 'AT', 'ATOMIC', 'AUTHORIZATION', 'AVG',
'BEFORE', 'BEGIN', 'BETWEEN', 'BIGINT', 'BINARY', 'BIT', 'BIT_LENGTH', 'BLOB', 'BOOLEAN', 'BOTH', 'BREADTH',
'BY', 'CALL', 'CALLED', 'CASCADE', 'CASCADED', 'CASE', 'CAST', 'CATALOG', 'CHAR', 'CHARACTER',
'CHARACTER_LENGTH', 'CHAR_LENGTH', 'CHECK', 'CLOB', 'CLOSE', 'COALESCE', 'COLLATE', 'COLLATION', 'COLUMN',
'COMMIT', 'CONDITION', 'CONNECT', 'CONNECTION', 'CONSTRAINT', 'CONSTRAINTS', 'CONSTRUCTOR', 'CONTAINS',
'CONTINUE', 'CONVERT', 'CORRESPONDING', 'COUNT', 'CREATE', 'CROSS', 'CUBE', 'CURRENT', 'CURRENT_DATE',
'CURRENT_DEFAULT_TRANSFORM_GROUP', 'CURRENT_PATH', 'CURRENT_ROLE', 'CURRENT_TIME', 'CURRENT_TIMESTAMP',
'CURRENT_TRANSFORM_GROUP_FOR_TYPE', 'CURRENT_USER', 'CURSOR', 'CYCLE', 'DATA', 'DATE', 'DAY', 'DEALLOCATE',
'DEC', 'DECIMAL', 'DECLARE', 'DEFAULT', 'DEFERRABLE', 'DEFERRED', 'DELETE', 'DEPTH', 'DEREF', 'DESC',
'DESCRIBE', 'DESCRIPTOR', 'DETERMINISTIC', 'DIAGNOSTICS', 'DISCONNECT', 'DISTINCT', 'DO', 'DOMAIN', 'DOUBLE',
'DROP', 'DYNAMIC', 'EACH', 'ELEMENT', 'ELSE', 'ELSEIF', 'END', 'EQUALS', 'ESCAPE', 'EXCEPT', 'EXCEPTION',
'EXEC', 'EXECUTE', 'EXISTS', 'EXIT', 'EXTERNAL', 'EXTRACT', 'FALSE', 'FETCH', 'FILTER', 'FIRST', 'FLOAT', 'FOR',
'FOREIGN', 'FOUND', 'FREE', 'FROM', 'FULL', 'FUNCTION', 'GENERAL', 'GET', 'GLOBAL', 'GO', 'GOTO', 'GRANT',
'GROUP', 'GROUPING', 'HANDLER', 'HAVING', 'HOLD', 'HOUR', 'IDENTITY', 'IF', 'IMMEDIATE', 'IN', 'INDICATOR',
'INITIALLY', 'INNER', 'INOUT', 'INPUT', 'INSENSITIVE', 'INSERT', 'INT', 'INTEGER', 'INTERSECT', 'INTERVAL',
'INTO', 'IS', 'ISOLATION', 'ITERATE', 'JOIN', 'KEY', 'LANGUAGE', 'LARGE', 'LAST', 'LATERAL', 'LEADING', 'LEAVE',
'LEFT', 'LEVEL', 'LIKE', 'LOCAL', 'LOCALTIME', 'LOCALTIMESTAMP', 'LOCATOR', 'LOOP', 'LOWER', 'MAP', 'MATCH',
'MAX', 'MEMBER', 'MERGE', 'METHOD', 'MIN', 'MINUTE', 'MODIFIES', 'MODULE', 'MONTH', 'MULTISET', 'NAMES',
'NATIONAL', 'NATURAL', 'NCHAR', 'NCLOB', 'NEW', 'NEXT', 'NO', 'NONE', 'NOT', 'NULL', 'NULLIF', 'NUMERIC',
'OBJECT', 'OCTET_LENGTH', 'OF', 'OLD', 'ON', 'ONLY', 'OPEN', 'OPTION', 'OR', 'ORDER', 'ORDINALITY', 'OUT',
'OUTER', 'OUTPUT', 'OVER', 'OVERLAPS', 'PAD', 'PARAMETER', 'PARTIAL', 'PARTITION', 'PATH', 'POSITION',
'PRECISION', 'PREPARE', 'PRESERVE', 'PRIMARY', 'PRIOR', 'PRIVILEGES', 'PROCEDURE', 'PUBLIC', 'RANGE', 'READ',
'READS', 'REAL', 'RECURSIVE', 'REF', 'REFERENCES', 'REFERENCING', 'RELATIVE', 'RELEASE', 'REPEAT', 'RESIGNAL',
'RESTRICT', 'RESULT', 'RETURN', 'RETURNS', 'REVOKE', 'RIGHT', 'ROLE', 'ROLLBACK', 'ROLLUP', 'ROUTINE', 'ROW',
'ROWS', 'SAVEPOINT', 'SCHEMA', 'SCOPE', 'SCROLL', 'SEARCH', 'SECOND', 'SECTION', 'SELECT', 'SENSITIVE',
'SESSION', 'SESSION_USER', 'SET', 'SETS', 'SIGNAL', 'SIMILAR', 'SIZE', 'SMALLINT', 'SOME', 'SPACE', 'SPECIFIC',
'SPECIFICTYPE', 'SQL', 'SQLCODE', 'SQLERROR', 'SQLEXCEPTION', 'SQLSTATE', 'SQLWARNING', 'START', 'STATE',
'STATIC', 'SUBMULTISET', 'SUBSTRING', 'SUM', 'SYMMETRIC', 'SYSTEM', 'SYSTEM_USER', 'TABLE', 'TABLESAMPLE',
'TEMPORARY', 'THEN', 'TIME', 'TIMESTAMP', 'TIMEZONE_HOUR', 'TIMEZONE_MINUTE', 'TO', 'TRAILING', 'TRANSACTION',
'TRANSLATE', 'TRANSLATION', 'TREAT', 'TRIGGER', 'TRIM', 'TRUE', 'UNDER', 'UNDO', 'UNION', 'UNIQUE', 'UNKNOWN',
'UNNEST', 'UNTIL', 'UPDATE', 'UPPER', 'USAGE', 'USER', 'USING', 'VALUE', 'VALUES', 'VARCHAR', 'VARYING', 'VIEW',
'WHEN', 'WHENEVER', 'WHERE', 'WHILE', 'WINDOW', 'WITH', 'WITHIN', 'WITHOUT', 'WORK', 'WRITE', 'YEAR', 'ZONE'
] as Set
//based on http://docs.jboss.org/hibernate/orm/3.6/reference/en-US/html/types.html#types-value-basic
private final hibernateBasicTypes = ['String', 'Character', 'boolean', 'Boolean', 'byte', 'Byte', 'short', 'Short',
'int', 'Integer', 'long', 'Long', 'float', 'Float', 'double', 'Double', 'BigInteger', 'BigDecimal', 'Timestamp',
'Time', 'Date', 'Calendar', 'Currency', 'Locale', 'TimeZone', 'URL', 'Class', 'Blob', 'Clob', '[B', 'Byte[]',
'[C', 'Character[]', 'UUID', 'Serializable'
] as Set
String additionalReservedSqlKeywords = ''
String additionalHibernateBasicTypes = ''
@Override
AstVisitor getAstVisitor() {
return new GrailsDomainReservedSqlKeywordNameAstVisitor(
reservedSqlKeywords + toSet(additionalReservedSqlKeywords),
hibernateBasicTypes + toSet(additionalHibernateBasicTypes)
)
}
private Set toSet(String listInString) {
listInString.split(/,\s*/).findAll { !it.isEmpty() } as Set
}
}
class GrailsDomainReservedSqlKeywordNameAstVisitor extends AbstractAstVisitor {
private final reservedSqlKeywords
private final hibernateBasicTypes
private final instanceFields = []
private transients = []
GrailsDomainReservedSqlKeywordNameAstVisitor(Set reservedSqlKeywords, Set hibernateBasicTypes) {
this.reservedSqlKeywords = reservedSqlKeywords*.toUpperCase()
this.hibernateBasicTypes = hibernateBasicTypes
}
@Override
protected void visitClassEx(ClassNode node) {
if (node.name.toUpperCase() in reservedSqlKeywords) {
addViolation(node, violationMessage(node.name, 'domain class name'))
}
}
@Override
protected void visitClassComplete(ClassNode node) {
addViolationsForInstanceFields()
}
@Override
void visitField(FieldNode node) {
if (node.inStaticContext) {
if (node.name == 'transients') {
extractTransients(node)
}
} else {
instanceFields << node
}
}
@SuppressWarnings('EmptyCatchBlock')
private void extractTransients(FieldNode transientsNode) {
try {
assert transientsNode.initialExpression instanceof ListExpression
def listExpression = transientsNode.initialExpression as ListExpression
assert listExpression.expressions.every { it instanceof ConstantExpression }
def expressions = listExpression.expressions as List
assert expressions.every { it.type.name == String.name }
transients = expressions*.value
} catch (AssertionError e) {
}
}
private addViolationsForInstanceFields() {
instanceFields.each { FieldNode field ->
if (hibernateWouldCreateColumnFor(field) && field.name.toUpperCase() in reservedSqlKeywords) {
addViolation(field, violationMessage(field.name, 'domain class\' field name'))
}
}
}
private boolean hibernateWouldCreateColumnFor(FieldNode field) {
!(field.dynamicTyped || field.name in transients) && field.type.name in hibernateBasicTypes
}
private String violationMessage(String identifier, String kindOfName) {
"'$identifier' is a reserved SQL keyword and - as such - a problematic $kindOfName."
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsPublicControllerMethodRule.groovy 0000644 0001750 0001750 00000006502 12311373552 032172 0 ustar ebourg ebourg /*
* 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.grails
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.WildcardPattern
import java.lang.reflect.Modifier
/**
* Rule that checks for public methods on Grails controller classes. Static methods are ignored.
*
* NOTE: This rule is DISABLED by default (i.e., by setting its enabled property to false).
* Given that Grails 2.x allows and encourages controller actions to be defined as methods instead of closures,
* this rule makes no more sense (for Grails 2.x projects).
*
* Grails controller actions and interceptors are defined as properties on the controller class.
* Public methods on a controller class are unnecessary. They break encapsulation and can
* be confusing.
*
* 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 '?').
*
* This rule sets the default value of applyToFilesMatching to only match files
* under the 'grails-app/controllers' folder. You can override this with a different regular
* expression value if appropriate.
*
* This rule also sets the default value of applyToClassNames to only match class
* names ending in 'Controller'. You can override this with a different class name pattern
* (String) if appropriate.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class GrailsPublicControllerMethodRule extends AbstractAstVisitorRule {
String name = 'GrailsPublicControllerMethod'
int priority = 2
String ignoreMethodNames
Class astVisitorClass = GrailsPublicControllerMethodAstVisitor
String applyToFilesMatching = GrailsUtil.CONTROLLERS_FILES
String applyToClassNames = GrailsUtil.CONTROLLERS_CLASSES
GrailsPublicControllerMethodRule() {
this.enabled = false // disabled by default
}
}
class GrailsPublicControllerMethodAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode methodNode) {
if (Modifier.isPublic(methodNode.modifiers)
&& !(methodNode.modifiers & MethodNode.ACC_STATIC)
&& !isIgnoredMethodName(methodNode)) {
addViolation(methodNode, "The Grails controller has a public method $methodNode.name. This should be a closure property or moved")
}
}
private boolean isIgnoredMethodName(MethodNode node) {
new WildcardPattern(rule.ignoreMethodNames, false).matches(node.name)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsUtil.groovy 0000644 0001750 0001750 00000002544 12311373552 025636 0 ustar ebourg ebourg /*
* 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.grails
/**
* Utility methods and constants for Grails rule classes. This class is not intended for general use.
*
* @author Chris Mair
*/
class GrailsUtil {
protected static final SERVICE_FILES = /.*grails-app\/services\/.*/
protected static final DOMAIN_FILES = /.*grails-app\/domain\/.*/
protected static final CONTROLLERS_FILES = /.*grails-app\/controllers\/.*/
protected static final CONTROLLERS_AND_TAGLIB_FILES = /.*grails-app\/(controllers|taglib)\/.*/
protected static final CONTROLLERS_CLASSES = '*Controller'
protected static final SERVICE_CLASSES = '*Service'
/**
* Private constructor. All members are static.
*/
private GrailsUtil() { }
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsStatelessServiceRule.groovy 0000644 0001750 0001750 00000010610 12311370173 031026 0 ustar ebourg ebourg /*
* 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.grails
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.generic.StatelessClassRule
/**
* Rule that checks for non-final fields on a Grails service class. Grails service
* classes are, by default, singletons, and so they should be reentrant. In most cases, this implies
* (or at least encourages) that they should be stateless.
*
* This rule ignores final fields (either instance or static). Fields that are
* static and non-final, however, do cause a violation.
*
* This rule ignores non-static properties (i.e., no visibility modifier specified) declared with "def".
*
* This rule also ignores fields annotated with the @Inject annotation.
*
* You can configure this rule to ignore certain fields either by name or by type. This can be
* useful to ignore fields that hold references to (static) dependencies (such as DAOs or
* Service objects) or static configuration.
*
* The ignoreFieldNames property specifies one or more (comma-separated) field names
* that should be ignored (i.e., that should not cause a rule violation). The name(s) may optionally
* include wildcard characters ('*' or '?'). You can add to the field names to be ignored by setting
* the (write-only) addIgnoreFieldNames property. This is a "special" property -- each
* call to setAddIgnoreFieldNames() adds to the existing ignoreFieldNames
* property value.
*
* The ignoreFieldTypes property specifies one or more (comma-separated) field type names
* that should be ignored (i.e., that should not cause a rule violation). The type name(s) may optionally
* include wildcard characters ('*' or '?').
*
* Note: The ignoreFieldTypes property matches the field type name as indicated
* in the field declaration, only including a full package specification IF it is included in
* the source code. For example, the field declaration BigDecimal value matches
* an ignoreFieldTypes value of BigDecimal, but not
* java.lang.BigDecimal.
*
* There is one exception for the ignoreFieldTypes property: if the field is declared
* with a modifier/type of def, then the type resolves to java.lang.Object.
*
* The ignoreFieldNames property of this rule is preconfigured to ignore the standard
* Grails service configuration field names ('scope', 'transactional') and injected bean names
* ('dataSource', 'sessionFactory'), as well as all other field names ending with 'Service'.
*
* This rule sets the default value of applyToFilesMatching to only match files
* under the 'grails-app/services' folder. You can override this with a different regular
* expression value if appropriate.
*
* This rule also sets the default value of applyToClassNames to only match class
* names ending in 'Service'. You can override this with a different class name pattern
* (String) if appropriate.
*
* @author Chris Mair
*/
class GrailsStatelessServiceRule extends StatelessClassRule {
String name = 'GrailsStatelessService'
int priority = 2
String applyToFilesMatching = GrailsUtil.SERVICE_FILES
String applyToClassNames = GrailsUtil.SERVICE_CLASSES
GrailsStatelessServiceRule() {
ignoreFieldNames = 'dataSource,scope,sessionFactory,transactional,*Service'
}
@Override
protected boolean shouldIgnoreField(FieldNode fieldNode) {
return super.shouldIgnoreField(fieldNode) ||
fieldNode.isDynamicTyped() && !fieldNode.static && fieldNode.synthetic
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsDuplicateConstraintRule.groovy 0000644 0001750 0001750 00000006407 12414042204 031521 0 ustar ebourg ebourg /*
* Copyright 2012 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.grails
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.expr.MethodCallExpression
/**
* Check for duplicate constraints entry
*
* @author Chris Mair
*/
class GrailsDuplicateConstraintRule extends AbstractAstVisitorRule {
String name = 'GrailsDuplicateConstraint'
int priority = 2
Class astVisitorClass = GrailsDuplicateConstraintAstVisitor
String applyToFilesMatching = GrailsUtil.DOMAIN_FILES
}
class GrailsDuplicateConstraintAstVisitor extends AbstractAstVisitor {
private final Set constraintNames = []
private boolean withinConstraint
@Override
void visitField(FieldNode node) {
if (node.name == 'constraints') {
withinConstraint = true
super.visitField(node)
withinConstraint = false
}
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (withinConstraint && isFirstVisit(call)) {
String methodName = call.methodAsString
if (methodName == 'importFrom') {
Collection importedConstraintNames = extractImportedConstraints(call.text)
constraintNames.intersect(importedConstraintNames).each {
addViolation(call, "The constraint for $it in domain class $currentClassName has already been specified")
}
constraintNames.addAll(importedConstraintNames)
}
else if (methodName in constraintNames) {
addViolation(call, "The constraint for $methodName in domain class $currentClassName has already been specified")
}
else {
constraintNames << methodName
}
}
}
/**
* Extract the properties included in an importFrom constraint definition. So far this just handles included properties.
* It doesn't currently support extracting all the properties from the given class, so no exclude: support either.
* @param text - e.g. "this.importFrom([include:[firstName]], Entity)"
* @return the collection of properties specifically included
*/
private static Collection extractImportedConstraints(String text) {
Collection importedConstraintNames = []
if (text.indexOf('include:') > 0) {
String collectionString = text[(text.lastIndexOf('[') + 1)..(text.indexOf(']') - 1)]
importedConstraintNames = collectionString.split(',')
}
importedConstraintNames
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsSessionReferenceRule.groovy 0000644 0001750 0001750 00000005151 12465006037 031011 0 ustar ebourg ebourg /*
* 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.grails
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that checks for references to the session object from within Grails controller and
* taglib classes.
*
* This rule is intended as a "governance" rule to enable monitoring and controlling access to the
* session from within application source code. Storing objects in the session may inhibit scalability
* and/or performance and should be carefully considered.
*
* Enabling this rule may make most sense in a team environment where team members exhibit a broad
* range of skill and experience levels. Appropriate session access can be configured as exceptions
* to this rule by configuring either the doNotApplyToFilenames or
* doNotApplyToFilesMatching property of the rule.
*
* This rule sets the default value of applyToFilesMatching to only match files
* under the 'grails-app/controllers' or 'grails-app/taglib' folders. You can override this
* with a different regular expression value if appropriate.
*
* @deprecated This rule is deprecated and disabled (enabled=false) by default
*
* @author Chris Mair
*/
class GrailsSessionReferenceRule extends AbstractAstVisitorRule {
String name = 'GrailsSessionReference'
int priority = 2
Class astVisitorClass = GrailsSessionReferenceAstVisitor
String applyToFilesMatching = GrailsUtil.CONTROLLERS_AND_TAGLIB_FILES
GrailsSessionReferenceRule() {
this.enabled = false // deprecated; disabled by default
}
}
class GrailsSessionReferenceAstVisitor extends AbstractAstVisitor {
void visitVariableExpression(VariableExpression expression) {
if (isFirstVisit(expression) && expression.variable == 'session') {
addViolation(expression, 'Interacting with the Grails session object can limit scalability')
}
super.visitVariableExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsDomainWithServiceReferenceRule.groovy 0000644 0001750 0001750 00000003111 12111536264 032742 0 ustar ebourg ebourg /*
* Copyright 2013 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.grails
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
/**
* Checks that Grails Domain classes do not have Service classes injected.
*
* @author Artur Gajowy
*/
class GrailsDomainWithServiceReferenceRule extends AbstractAstVisitorRule {
String name = 'GrailsDomainWithServiceReference'
int priority = 2
Class astVisitorClass = GrailsDomainCantReferenceServiceAstVisitor
String applyToFilesMatching = GrailsUtil.DOMAIN_FILES
}
class GrailsDomainCantReferenceServiceAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (node.name.endsWith('Service')) {
def domainName = node.declaringClass.nameWithoutPackage
addViolation(node, "Domain class $domainName should not reference services (offending field: ${node.name})")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsDuplicateMappingRule.groovy 0000644 0001750 0001750 00000004241 12056540656 031002 0 ustar ebourg ebourg /*
* Copyright 2012 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.grails
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.FieldNode
/**
* Check for duplicate entry in a domain class mapping
*
* @author Chris Mair
*/
class GrailsDuplicateMappingRule extends AbstractAstVisitorRule {
String name = 'GrailsDuplicateMapping'
int priority = 2
Class astVisitorClass = GrailsDuplicateMappingAstVisitor
String applyToFilesMatching = GrailsUtil.DOMAIN_FILES
}
class GrailsDuplicateMappingAstVisitor extends AbstractAstVisitor {
private final Set mappingNames = []
private boolean withinMapping
@Override
void visitField(FieldNode node) {
if (node.name == 'mapping') {
withinMapping = true
super.visitField(node)
withinMapping = false
}
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (withinMapping && isFirstVisit(call)) {
def name = call.methodAsString
if (name in mappingNames) {
addViolation(call, "The mapping for $name in domain class $currentClassName has already been specified")
}
else {
mappingNames << name
}
// Process optional nested columns closure
if (name == 'columns') {
super.visitMethodCallExpression(call)
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsDomainHasToStringRule.groovy 0000644 0001750 0001750 00000003460 12041642132 031075 0 ustar ebourg ebourg /*
* Copyright 2012 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.grails
import static org.codenarc.util.AstUtil.hasAnnotation
import static org.codenarc.util.AstUtil.isMethodNode
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Checks that Grails domain classes redefine toString()
*
* @author Geli Crick
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class GrailsDomainHasToStringRule extends AbstractAstVisitorRule {
String name = 'GrailsDomainHasToString'
int priority = 2
Class astVisitorClass = GrailsDomainHasToStringAstVisitor
String applyToFilesMatching = GrailsUtil.DOMAIN_FILES
}
class GrailsDomainHasToStringAstVisitor extends AbstractAstVisitor {
void visitClassComplete(ClassNode classNode) {
if (isFirstVisit(classNode) && !hasAnnotation(classNode, 'ToString') && !hasAnnotation(classNode, 'Canonical')) {
if (!classNode.methods.any { isMethodNode(it, 'toString', 0) }) {
addViolation(classNode, "The domain class $classNode.name should define a toString() method")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/grails/GrailsDomainHasEqualsRule.groovy 0000644 0001750 0001750 00000003461 12275775574 030611 0 ustar ebourg ebourg /*
* Copyright 2012 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.grails
import static org.codenarc.util.AstUtil.hasAnnotation
import static org.codenarc.util.AstUtil.isMethodNode
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Checks that Grails domain classes redefine equals().
*
* @author Geli Crick
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class GrailsDomainHasEqualsRule extends AbstractAstVisitorRule {
String name = 'GrailsDomainHasEquals'
int priority = 2
Class astVisitorClass = GrailsDomainHasEqualsAstVisitor
String applyToFilesMatching = GrailsUtil.DOMAIN_FILES
}
class GrailsDomainHasEqualsAstVisitor extends AbstractAstVisitor {
void visitClassComplete(ClassNode classNode) {
if (isFirstVisit(classNode) && !hasAnnotation(classNode, 'EqualsAndHashCode') && !hasAnnotation(classNode, 'Canonical')) {
if (!classNode.methods.any { isMethodNode(it, 'equals', 1) }) {
addViolation(classNode, "The domain class $classNode.name should define an equals(Object) method")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/AstVisitor.groovy 0000644 0001750 0001750 00000002546 12311373552 024407 0 ustar ebourg ebourg /*
* Copyright 2008 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
import org.codehaus.groovy.ast.GroovyClassVisitor
import org.codenarc.source.SourceCode
/**
* Interface for Groovy AST Visitors used with Rules
*
* @author Chris Mair
*/
interface AstVisitor extends GroovyClassVisitor {
/**
* Set the Rule associated with this visitor
* @param rule - the Rule
*/
void setRule(Rule rule)
/**
* Set the SourceCode associated with this visitor
* @param sourceCode - the SourceCode
*/
void setSourceCode(SourceCode sourceCode)
/**
* Retrieve the List of Violations resulting from applying this visitor
* @return the List of Violations; may be empty
*/
List getViolations()
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/StubRule.groovy 0000644 0001750 0001750 00000002045 12311373552 024037 0 ustar ebourg ebourg /*
* Copyright 2012 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
import org.codenarc.source.SourceCode
/**
* Stub implementation of the Rule interface for testing
*
* @author Chris Mair
*/
class StubRule extends AbstractRule {
int priority
String name
StubRule() {
}
StubRule(int priority) {
this.priority = priority
}
@Override
void applyTo(SourceCode sourceCode, List violations) {
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/ 0000755 0001750 0001750 00000000000 12623571301 023202 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/VectorIsObsoleteRule.groovy 0000644 0001750 0001750 00000002537 12006632014 030535 0 ustar ebourg ebourg /*
* Copyright 2012 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.convention
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
import org.codenarc.rule.ClassReferenceAstVisitor
/**
* Check for direct use of Vector or java.util.Vector.
*
* Known limitation: Does not catch references as Anonymous Inner class: def x = new java.util.Vector() { .. }
*
* @author Chris Mair
*/
class VectorIsObsoleteRule extends AbstractAstVisitorRule {
String name = 'VectorIsObsolete'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ClassReferenceAstVisitor('Vector, java.util.Vector', 'The {0} class is obsolete. Use classes from the Java Collections Framework instead, including ArrayList or Collections.synchronizedList().')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/IfStatementCouldBeTernaryRule.groovy 0000644 0001750 0001750 00000010747 12311373552 032342 0 ustar ebourg ebourg /*
* Copyright 2012 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.convention
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.ReturnStatement
import org.codehaus.groovy.ast.ASTNode
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.GStringExpression
/**
* Checks for:
*
* (1) An if statements where both the if and else blocks contain only a single return statement with a constant or
* literal value.
*
* (2) When the second-to-last statement in a block is an if statement with no else, where the block contains a single
* return statement, and the last statement in the block is a return statement, and both return statements return a
* constant or literal value. This checks can be disabled by setting checkLastStatementImplicitElse to false.
*
* @author Chris Mair
*/
class IfStatementCouldBeTernaryRule extends AbstractAstVisitorRule {
String name = 'IfStatementCouldBeTernary'
int priority = 2
Class astVisitorClass = IfStatementCouldBeTernaryAstVisitor
boolean checkLastStatementImplicitElse = true
}
class IfStatementCouldBeTernaryAstVisitor extends AbstractAstVisitor {
@Override
void visitIfElse(IfStatement ifElse) {
if (isFirstVisit(ifElse) && isOnlyReturnStatement(ifElse.ifBlock) && isOnlyReturnStatement(ifElse.elseBlock)) {
def ternaryExpression = "return ${ifElse.booleanExpression.text} ? ${getReturnValue(ifElse.ifBlock)} : ${getReturnValue(ifElse.elseBlock)}"
addViolation(ifElse, "The if statement in class $currentClassName can be rewritten using the ternary operator: $ternaryExpression")
}
super.visitIfElse(ifElse)
}
@Override
void visitBlockStatement(BlockStatement block) {
def allStatements = block.statements
if (allStatements.size() > 1 && rule.checkLastStatementImplicitElse) {
def nextToLastStatement = allStatements[-2]
if (nextToLastStatement instanceof IfStatement && hasNoElseBlock(nextToLastStatement)) {
def lastStatement = allStatements[-1]
IfStatement ifStatement = nextToLastStatement
if (isOnlyReturnStatement(ifStatement.ifBlock) && isReturnStatementWithConstantOrLiteralValue(lastStatement)) {
def elseReturnExpression = AstUtil.createPrettyExpression(lastStatement.expression)
def ternaryExpression = "return ${ifStatement.booleanExpression.text} ? ${getReturnValue(ifStatement.ifBlock)} : ${elseReturnExpression}"
addViolation(ifStatement, "The if statement in class $currentClassName can be rewritten using the ternary operator: $ternaryExpression")
}
}
}
super.visitBlockStatement(block)
}
private boolean hasNoElseBlock(IfStatement ifStatement) {
ifStatement.elseBlock.empty
}
private boolean isOnlyReturnStatement(ASTNode node) {
isBlockWithSingleReturnStatement(node) || isReturnStatementWithConstantOrLiteralValue(node)
}
private boolean isBlockWithSingleReturnStatement(ASTNode node) {
return node instanceof BlockStatement &&
node.statements.size() == 1 &&
isReturnStatementWithConstantOrLiteralValue(node.statements[0])
}
private boolean isReturnStatementWithConstantOrLiteralValue(ASTNode node) {
return node instanceof ReturnStatement &&
(AstUtil.isConstantOrLiteral(node.expression) || node.expression instanceof GStringExpression)
}
private String getReturnValue(ASTNode node) {
def expr = node instanceof BlockStatement ? node.statements[0].expression : node.expression
return AstUtil.createPrettyExpression(expr)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/HashtableIsObsoleteRule.groovy 0000644 0001750 0001750 00000002537 12006632014 031166 0 ustar ebourg ebourg /*
* Copyright 2012 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.convention
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
import org.codenarc.rule.ClassReferenceAstVisitor
/**
* Check for direct use of Vector or java.util.Hashtable.
*
* Known limitation: Does not catch references as Anonymous Inner class: def x = new java.util.Vector() { .. }
*
* @author Chris Mair
*/
class HashtableIsObsoleteRule extends AbstractAstVisitorRule {
String name = 'HashtableIsObsolete'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ClassReferenceAstVisitor('Hashtable, java.util.Hashtable', 'The {0} class is obsolete. Use classes from the Java Collections Framework instead, including HashMap or ConcurrentHashMap.')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/InvertedIfElseRule.groovy 0000644 0001750 0001750 00000004434 12141451554 030160 0 ustar ebourg ebourg /*
* 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.convention
import org.codehaus.groovy.ast.expr.NotExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codehaus.groovy.ast.stmt.Statement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* An inverted if-else statement is one in which there is a single if statement with a single else branch and the
* boolean test of the if is negated. For instance "if (!x) false else true". It is usually clearer to write this as
* "if (x) true else false".
*
* @author Hamlet D'Arcy
*/
class InvertedIfElseRule extends AbstractAstVisitorRule {
String name = 'InvertedIfElse'
int priority = 3
Class astVisitorClass = InvertedIfElseAstVisitor
}
class InvertedIfElseAstVisitor extends AbstractAstVisitor {
void visitIfElse(IfStatement ifElse) {
if (ifElse.booleanExpression.expression instanceof NotExpression) {
if (ifElse.elseBlock instanceof BlockStatement) {
addViolation ifElse.booleanExpression, 'Testing the negative condition first can make an if statement confusing'
}
}
dispatchToIfWithoutSuper ifElse
}
private void dispatchToIfWithoutSuper(IfStatement ifElse) {
// no need to visit boolean expression
// if block might have another instance of this error
ifElse.ifBlock.visit(this)
Statement elseBlock = ifElse.elseBlock
if (elseBlock instanceof IfStatement) {
// uh-oh found an if-elseif-else
dispatchToIfWithoutSuper elseBlock
} else {
elseBlock.visit(this)
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/TernaryCouldBeElvisRule.groovy 0000644 0001750 0001750 00000004527 12311373552 031200 0 ustar ebourg ebourg /*
* Copyright 2012 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.convention
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.expr.*
/**
* Rule that checks for ternary expressions where the boolean and true expressions are the same.
* These can be simplified to an Elvis expression.
*
* @author Chris Mair
*/
class TernaryCouldBeElvisRule extends AbstractAstVisitorRule {
String name = 'TernaryCouldBeElvis'
int priority = 3
Class astVisitorClass = TernaryCouldBeElvisAstVisitor
}
class TernaryCouldBeElvisAstVisitor extends AbstractAstVisitor {
@Override
void visitTernaryExpression(TernaryExpression expression) {
if (isNotElvis(expression) && areTheSame(expression.booleanExpression.expression, expression.trueExpression)) {
def asElvis = "${expression.trueExpression.text} ?: ${expression.falseExpression.text}"
addViolation(expression, "${expression.text} in class $currentClassName can be simplified to $asElvis")
}
super.visitTernaryExpression(expression)
}
private boolean isNotElvis(TernaryExpression expression) {
return !(expression instanceof ElvisOperatorExpression)
}
private boolean areTheSame(Expression booleanExpression, Expression trueExpression) {
if (booleanExpression.class != trueExpression.class) {
return false
}
if (booleanExpression instanceof VariableExpression) {
return booleanExpression.name == trueExpression.name
}
if (booleanExpression instanceof MethodCallExpression) {
return booleanExpression.text == trueExpression.text
}
return false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/NoDefRule.groovy 0000644 0001750 0001750 00000003212 12414302312 026262 0 ustar ebourg ebourg /*
* Copyright 2014 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.convention
import org.codenarc.rule.AbstractRule
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
import java.util.regex.Pattern
/**
* Def keyword is overused and should be replaced with specific type.
*
* The excludeRegex property optionally specifies regex
* to find text which could occur immediately after def.
*
* @author Dominik Przybysz
*/
class NoDefRule extends AbstractRule {
String name = 'NoDef'
int priority = 3
protected static final String MESSAGE = 'def should not be used'
String excludeRegex
@Override
void applyTo(SourceCode sourceCode, List violations) {
Pattern excludeFilter = excludeRegex ? ~/.*def\s+$excludeRegex.*/ : null
sourceCode.lines.eachWithIndex {
String line, int idx ->
if (line.contains('def ') && (!excludeFilter || !(line ==~ excludeFilter))) {
violations << createViolation(idx + 1, line.trim(), MESSAGE)
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/ParameterReassignmentRule.groovy 0000644 0001750 0001750 00000006030 12041061500 031565 0 ustar ebourg ebourg /*
* Copyright 2012 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.convention
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Checks for a method or closure parameter being reassigned to a new value within the body of the
* method/closure, which is a confusing, questionable practice. Use a temporary variable instead.
*
* @author Chris Mair
*/
class ParameterReassignmentRule extends AbstractAstVisitorRule {
String name = 'ParameterReassignment'
int priority = 3
Class astVisitorClass = ParameterReassignmentAstVisitor
}
class ParameterReassignmentAstVisitor extends AbstractAstVisitor {
private currentMethodParameterNames
private final currentClosureParameterNames = []
@Override
protected void visitMethodEx(MethodNode node) {
currentMethodParameterNames = node.parameters.name
super.visitMethodEx(node)
}
@Override
protected void visitMethodComplete(MethodNode node) {
super.visitMethodComplete(node)
currentMethodParameterNames = []
}
@Override
void visitClosureExpression(ClosureExpression expression) {
def parameterNames = expression.parameters?.name ?: []
currentClosureParameterNames.addAll(parameterNames)
super.visitClosureExpression(expression)
currentClosureParameterNames.removeAll(parameterNames)
}
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (isFirstVisit(expression) && isReassigningAParameter(expression)) {
def name = expression.leftExpression.name
addViolation(expression, "The method parameter [$name] in class $currentClassName was reassigned. Use a temporary variable instead.")
}
super.visitBinaryExpression(expression)
}
private boolean isReassigningAParameter(BinaryExpression expression) {
expression.operation.text == '=' &&
expression.leftExpression instanceof VariableExpression &&
isCurrentParameterName(expression.leftExpression.name)
}
private boolean isCurrentParameterName(String name) {
name in currentMethodParameterNames || name in currentClosureParameterNames
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/ConfusingTernaryRule.groovy 0000644 0001750 0001750 00000006022 12311370173 030577 0 ustar ebourg ebourg /*
* 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.convention
import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.NotExpression
import org.codehaus.groovy.ast.expr.TernaryExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* In an "if" expression with an "else" clause, avoid negation in the test. For example, rephrase:
* if (x != y) diff(); else same();
* as:
* if (x == y) same(); else diff();
* Most "if (x != y)" cases without an "else" are often return cases, so consistent use of this rule makes the code
* easier to read. Also, this resolves trivial ordering problems, such as "does the error case go first?" or "does
* the common case go first?".
*
* @author Hamlet D'Arcy
*/
class ConfusingTernaryRule extends AbstractAstVisitorRule {
String name = 'ConfusingTernary'
int priority = 3
Class astVisitorClass = ConfusingTernaryAstVisitor
}
class ConfusingTernaryAstVisitor extends AbstractAstVisitor {
@Override
void visitTernaryExpression(TernaryExpression expression) {
if (expression.booleanExpression.expression instanceof BinaryExpression) {
addViolationForBinaryExpression(expression.booleanExpression.expression, expression)
} else if (expression.booleanExpression.expression instanceof NotExpression) {
addViolationForNotExpression(expression, expression.booleanExpression.expression)
}
super.visitTernaryExpression(expression)
}
private addViolationForNotExpression(TernaryExpression expression, NotExpression exp) {
addViolation(expression, "(!$exp.text) is a confusing negation in a ternary expression. Rewrite as ($exp.expression.text) and invert the conditions.")
}
private addViolationForBinaryExpression(BinaryExpression exp, TernaryExpression expression) {
if (exp.operation.text == '!=') {
if (AstUtil.isNull(exp.leftExpression) || AstUtil.isNull(exp.rightExpression)) {
return
}
if (AstUtil.isBoolean(exp.leftExpression) || AstUtil.isBoolean(exp.rightExpression)) {
return
}
def suggestion = "($exp.leftExpression.text == $exp.rightExpression.text)"
addViolation(expression, "$exp.text is a confusing negation in a ternary expression. Rewrite as $suggestion and invert the conditions.")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/LongLiteralWithLowerCaseLRule.groovy 0000644 0001750 0001750 00000004110 12461172330 032265 0 ustar ebourg ebourg /*
* Copyright 2011 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.convention
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* In Java and Groovy, you can specify long literals with the L or l character, for instance 55L or
* 24l. It is best practice to always use an uppercase L and never a lowercase l. This is
* because 11l rendered in some fonts may look like 111 instead of 11L.
*
* @author Hamlet D'Arcy
*/
class LongLiteralWithLowerCaseLRule extends AbstractAstVisitorRule {
String name = 'LongLiteralWithLowerCaseL'
int priority = 2
Class astVisitorClass = LongLiteralWithLowerCaseLAstVisitor
}
class LongLiteralWithLowerCaseLAstVisitor extends AbstractAstVisitor {
@Override
void visitConstantExpression(ConstantExpression expression) {
if (!isFirstVisit(expression)) {
return
}
if (expression.type.name in ['long', 'java.lang.Long']) {
def line = getSourceCode().lines[expression.lineNumber - 1]
if (line?.length() <= expression.lastColumnNumber) {
def definition = line[expression.lastColumnNumber - 2]
if (definition == 'l') {
addViolation(expression, "The literal ${expression.value}l should be rewritten ${expression.value}L")
}
}
}
super.visitConstantExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/convention/CouldBeElvisRule.groovy 0000644 0001750 0001750 00000005414 12311373552 027627 0 ustar ebourg ebourg /*
* Copyright 2011 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.convention
import org.codehaus.groovy.ast.expr.NotExpression
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Catch an if block that could be written as an elvis expression.
*
* @author GUM
* @author Chris Mair
*/
class CouldBeElvisRule extends AbstractAstVisitorRule {
String name = 'CouldBeElvis'
int priority = 3
Class astVisitorClass = CouldBeElvisAstVisitor
}
class CouldBeElvisAstVisitor extends AbstractAstVisitor {
@Override
void visitIfElse(IfStatement node) {
addViolationCouldBeElvis(node)
super.visitIfElse(node)
}
private addViolationCouldBeElvis(IfStatement node) {
def conditionalCheck = node.booleanExpression?.expression
if (conditionalCheck instanceof NotExpression) {
def bodyOfIfStatement = getSingleStatementExpressionOrNull(node.ifBlock)
if (AstUtil.isBinaryExpressionType(bodyOfIfStatement, '=')) {
def conditionalText = conditionalCheck.expression.text
def leftAssignText = bodyOfIfStatement.leftExpression.text
// space check is a safe guard against crazy ass AST getText() implementations
if (conditionalText == leftAssignText && !conditionalText.contains(' ')) {
def rightText = AstUtil.createPrettyExpression(bodyOfIfStatement.rightExpression)
def rewrite = "$leftAssignText = $leftAssignText ?: $rightText "
addViolation(node, "Code could use elvis operator: $rewrite")
}
}
}
}
private getSingleStatementExpressionOrNull(ifBlock) {
if (AstUtil.isOneLiner(ifBlock) && AstUtil.respondsTo(ifBlock.statements[0], 'expression') ) {
return ifBlock.statements[0].expression
}
if (ifBlock instanceof ExpressionStatement) {
return ifBlock.expression
}
return null
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/ClassReferenceAstVisitor.groovy 0000644 0001750 0001750 00000012355 12041061502 027200 0 ustar ebourg ebourg /*
* Copyright 2012 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
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.ModuleNode
import org.codenarc.util.WildcardPattern
import java.text.MessageFormat
import org.codehaus.groovy.ast.expr.*
/**
* AstVisitor that check for references for a named class
*
* @author Chris Mair
*/
class ClassReferenceAstVisitor extends AbstractAstVisitor {
private final classNamePattern
private final String violationMessagePattern
/**
* Constructor
* @param classNames - one or more comma-separated class name patterns. Can contain wildcards (*,?)
*/
ClassReferenceAstVisitor(String classNames) {
this(classNames, 'Found reference to {0}')
}
/**
* Constructor
* @param classNames - one or more comma-separated class name patterns. Can contain wildcards (*,?)
* @param violationMessagePattern - the MessageFormat String pattern used to build the violation message.
* The class name is passed as the single argument to the pattern. e.g. "Found reference to {0}"
*/
ClassReferenceAstVisitor(String classNames, String violationMessagePattern) {
this.classNamePattern = new WildcardPattern(classNames)
this.violationMessagePattern = violationMessagePattern
}
@Override
void visitImports(ModuleNode node) {
def allImports = node.imports + node.staticStarImports.values()
allImports?.each { importNode ->
if (classNamePattern.matches(importNode.className)) {
def violationMessage = formatViolationMessage(importNode.className)
addViolation(rule.createViolationForImport(sourceCode, importNode, violationMessage))
}
}
super.visitImports(node)
}
@Override
void visitField(FieldNode node) {
checkNodeType(node)
super.visitField(node)
}
@Override
void visitPropertyExpression(PropertyExpression expression) {
checkType(expression.text, expression)
super.visitPropertyExpression(expression)
}
@Override
void visitClassExpression(ClassExpression expression) {
checkNodeType(expression)
super.visitClassExpression(expression)
}
@Override
void visitConstructorCallExpression(ConstructorCallExpression node) {
if (isFirstVisit(node)) {
checkNodeType(node)
}
super.visitConstructorCallExpression(node)
}
@Override
void visitVariableExpression(VariableExpression expression) {
checkNodeType(expression)
checkType(expression.name, expression)
super.visitVariableExpression(expression)
}
@Override
void visitConstructorOrMethod(MethodNode node, boolean isConstructor) {
checkType(node.returnType.name, node)
node.parameters.each { parameter ->
checkNodeType(parameter)
}
super.visitConstructorOrMethod(node, isConstructor)
}
@Override
void visitClosureExpression(ClosureExpression expression) {
expression.parameters.each { parameter ->
checkNodeType(parameter)
}
super.visitClosureExpression(expression)
}
@Override
void visitCastExpression(CastExpression expression) {
checkNodeType(expression)
super.visitCastExpression(expression)
}
@Override
protected void visitClassEx(ClassNode node) {
def superClassName = node.superClass.name
if (superClassName != 'java.lang.Object') {
checkType(superClassName, node)
}
node.interfaces.each { interfaceNode ->
checkType(interfaceNode.name, node)
}
super.visitClassEx(node)
}
//--------------------------------------------------------------------------
// Helper Methods
//--------------------------------------------------------------------------
private void checkType(String type, node) {
if (classNamePattern.matches(type)) {
def violationMessage = formatViolationMessage(type)
addViolation(node, violationMessage)
}
}
private void checkNodeType(node) {
if (classNamePattern.matches(node.type.name)) {
def violationMessage = formatViolationMessage(node.type.name)
addViolation(node, violationMessage)
}
}
private String formatViolationMessage(String typeName) {
MessageFormat.format(violationMessagePattern, typeName)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/serialization/ 0000755 0001750 0001750 00000000000 12623571301 023675 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/serialization/SerialPersistentFieldsRule.groovy 0000644 0001750 0001750 00000004537 12041061502 032423 0 ustar ebourg ebourg /*
* Copyright 2011 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.serialization
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* To use a Serializable object's serialPersistentFields correctly, it must be declared private, static, and final.
*
* @author 'Hamlet D'Arcy'
*/
class SerialPersistentFieldsRule extends AbstractAstVisitorRule {
String name = 'SerialPersistentFields'
int priority = 2
Class astVisitorClass = SerialPersistentFieldsAstVisitor
}
class SerialPersistentFieldsAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (AstUtil.classNodeImplementsType(node.owner, Serializable)) {
if (node.name == 'serialPersistentFields') {
if (!AstUtil.classNodeImplementsType(node.type, ObjectStreamField[].class)) {
addViolation(node, "The class is Serializable and defines a field named serialPersistentFields of type $node.type.name. The field should be declared as a ObjectStreamField[] instead")
} else if (!Modifier.isFinal(node.modifiers) || !Modifier.isStatic(node.modifiers) || !Modifier.isPrivate(node.modifiers)) {
addViolation(node, 'The class is Serializable and defines a field named serialPersistentFields which is not private, static, and final')
}
} else if (node.name?.toLowerCase() == 'serialpersistentfields') {
addViolation(node, "The class is Serializable and defines a field named $node.name. This should be named serialPersistentFields instead")
}
}
}
}
././@LongLink 0000644 0000000 0000000 00000000165 00000000000 011605 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/serialization/SerializableClassMustDefineSerialVersionUIDRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/serialization/SerializableClassMustDefineSerialVersi0000644 0001750 0001750 00000003215 12311370173 033350 0 ustar ebourg ebourg /*
* 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.serialization
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Classes that implement Serializable should define a serialVersionUID.
*
* @author 'Hamlet D'Arcy'
*/
class SerializableClassMustDefineSerialVersionUIDRule extends AbstractAstVisitorRule {
String name = 'SerializableClassMustDefineSerialVersionUID'
int priority = 2
Class astVisitorClass = SerializableClassMustDefineSerialVersionUIDAstVisitor
}
class SerializableClassMustDefineSerialVersionUIDAstVisitor extends AbstractAstVisitor {
@Override
protected void visitClassEx(ClassNode node) {
if (AstUtil.classNodeImplementsType(node, Serializable)) {
if (!node.fields.find { it.name == 'serialVersionUID' }) {
addViolation(node, "The class $node.name implements Serializable but does not define a serialVersionUID")
}
}
super.visitClassEx(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/serialization/SerialVersionUIDRule.groovy 0000644 0001750 0001750 00000004417 12311373552 031133 0 ustar ebourg ebourg /*
* 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.serialization
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.PropertyNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import java.lang.reflect.Modifier
/**
* Rule that checks that serialVersionUID field is static final and type long, and is not a property.
*
* @author Hamlet D'Arcy
*/
class SerialVersionUIDRule extends AbstractAstVisitorRule {
String name = 'SerialVersionUID'
int priority = 2
Class astVisitorClass = SerialVersionUIDAstVisitor
}
class SerialVersionUIDAstVisitor extends AbstractAstVisitor {
private final static SERIAL_ID = 'serialVersionUID'
void visitField(FieldNode node) {
if (node?.name == SERIAL_ID) {
if (!Modifier.isPrivate(node?.modifiers)) {
addViolation node, 'serialVersionUID found that is not private.'
}
if (!Modifier.isStatic(node?.modifiers)) {
addViolation node, 'serialVersionUID found that is not static.'
}
if (!Modifier.isFinal(node?.modifiers)) {
addViolation node, 'serialVersionUID found that is not final.'
}
if (node?.type?.name != 'long') {
addViolation node, 'serialVersionUID found that is not long. Found: ' + node?.type?.name
}
}
super.visitField node
}
void visitProperty(PropertyNode node) {
if (node?.name == SERIAL_ID) {
addViolation node, 'serialVersionUID found that is a property. '
}
super.visitProperty(node)
}
}
././@LongLink 0000644 0000000 0000000 00000000150 00000000000 011577 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/serialization/EnumCustomSerializationIgnoredRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/serialization/EnumCustomSerializationIgnoredRule.gro0000644 0001750 0001750 00000005110 12311373552 033402 0 ustar ebourg ebourg /*
* Copyright 2013 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.serialization
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import java.lang.reflect.Modifier
/**
* Checks for enums that define writeObject() or writeReplace() methods, or declare
* serialPersistentFields or serialVersionUID fields, all of which are ignored for enums.
*
* @author Chris Mair
*/
class EnumCustomSerializationIgnoredRule extends AbstractAstVisitorRule {
String name = 'EnumCustomSerializationIgnored'
int priority = 2
Class astVisitorClass = EnumCustomSerializationIgnoredAstVisitor
}
class EnumCustomSerializationIgnoredAstVisitor extends AbstractAstVisitor {
@Override
void visitField(FieldNode node) {
if (currentClassNode.isEnum()) {
if (isPrivateStaticFinalField(node, 'serialVersionUID') || isPrivateStaticFinalField(node, 'serialPersistentFields')) {
addViolation(node, "Field ${node.name} in class $currentClassName is ignored for enums")
}
}
}
@Override
protected void visitMethodComplete(MethodNode node) {
if (currentClassNode.isEnum()) {
if (isWriteReplaceMethod(node) || isWriteObjectMethod(node)) {
addViolation(node, "Method ${node.name}() in class $currentClassName is ignored for enums")
}
}
}
private isWriteObjectMethod(MethodNode node) {
node.name == 'writeObject' && node?.parameters.size() == 1 && node.parameters[0].type.name == 'ObjectOutputStream'
}
private isWriteReplaceMethod(MethodNode node) {
node.name == 'writeReplace' && !node.parameters
}
private boolean isPrivateStaticFinalField(FieldNode node, String name) {
return node?.name == name &&
Modifier.isPrivate(node?.modifiers) &&
Modifier.isStatic(node?.modifiers) &&
Modifier.isFinal(node?.modifiers)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ 0000755 0001750 0001750 00000000000 12623571301 023056 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToGetAtMethodRule.groovy 0000644 0001750 0001750 00000003062 12141456400 032121 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the getAt(Object) method is called directly in code instead of using the [] index operator. A groovier way to express this: a.getAt(b) is this: a[b]
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToGetAtMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToGetAtMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToGetAtMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToGetAtMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToGetAtMethodAstVisitor() {
super('getAt')
}
@Override
protected String getViolationMessage(MethodCallExpression call) {
"Explicit call to ${call.text} method can be rewritten as ${call.objectExpression.text}[${call.arguments.text}]"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToAndMethodRule.groovy 0000644 0001750 0001750 00000003030 12141456440 031616 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the and(Object) method is called directly in code instead of using the & operator. A groovier way to express this: a.and(b) is this: a & b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToAndMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToAndMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToAndMethodAstVisitor
boolean ignoreThisReference = true
}
class ExplicitCallToAndMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToAndMethodAstVisitor() {
super('and')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} & ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitArrayListInstantiationRule.groovy 0000644 0001750 0001750 00000002627 12141456634 033353 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* This rule checks for the explicit instantiation of an ArrayList using the no-arg constructor.
* In Groovy, it is best to write "new ArrayList()" as "[]", which creates the same object.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class ExplicitArrayListInstantiationRule extends AbstractAstVisitorRule {
String name = 'ExplicitArrayListInstantiation'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ExplicitTypeInstantiationAstVisitor('ArrayList') {
@Override
protected String createErrorMessage() {
'ArrayList objects are better instantiated using the form "[]"'
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitTreeSetInstantiationRule.groovy 0000644 0001750 0001750 00000002644 12141456644 033014 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* This rule checks for the explicit instantiation of a TreeSet using the no-arg constructor.
* In Groovy, it is best to write "new TreeSet()" as "[] as SortedSet", which creates the same object.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class ExplicitTreeSetInstantiationRule extends AbstractAstVisitorRule {
String name = 'ExplicitTreeSetInstantiation'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ExplicitTypeInstantiationAstVisitor('TreeSet') {
@Override
protected String createErrorMessage() {
'TreeSet objects are better instantiated using the form "[] as SortedSet"'
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitHashSetInstantiationRule.groovy 0000644 0001750 0001750 00000002651 12311373552 032771 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* This rule checks for the explicit instantiation of a HashSet using the no-arg constructor.
* In Groovy, it is best to write "new HashSet()" as "[] as Set", which creates the same object.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class ExplicitHashSetInstantiationRule extends AbstractAstVisitorRule {
String name = 'ExplicitHashSetInstantiation'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ExplicitTypeInstantiationAstVisitor('HashSet') {
@Override
protected String createErrorMessage() {
'HashSet objects are better instantiated using the form "[] as Set"'
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ConfusingMultipleReturnsRule.groovy 0000644 0001750 0001750 00000010224 12462775514 032223 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.expr.DeclarationExpression
import org.codehaus.groovy.ast.expr.EmptyExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Multiple return values can be used to set several variables at once. To use multiple return values, the left hand
* side of the assignment must be enclosed in parenthesis. If not, then you are not using multiple return values,
* you're only assigning the last element.
*
* @author Hamlet D'Arcy
*/
class ConfusingMultipleReturnsRule extends AbstractAstVisitorRule {
String name = 'ConfusingMultipleReturns'
int priority = 2
Class astVisitorClass = ConfusingMultipleReturnsAstVisitor
}
class ConfusingMultipleReturnsAstVisitor extends AbstractAstVisitor {
Set declarations = [] as Set
@Override
void visitDeclarationExpression(DeclarationExpression expression) {
declarations << expression
super.visitDeclarationExpression(expression)
}
@Override
protected void visitClassEx(ClassNode node) {
declarations.clear() // clear it out for next iteration
def fields = node.fields.
groupBy { FieldNode f -> f.lineNumber }.
values().
findAll { Collection c -> c.size() > 1 }
for (Collection nodes : fields) {
nodes.sort { it.columnNumber }
addViolationsForMultipleFieldDeclarations(nodes)
}
super.visitClassEx(node)
}
@Override
protected void visitClassComplete(ClassNode node) {
def declarationsOnSingleLine = declarations.
groupBy { DeclarationExpression d -> d.lineNumber }.
values().
findAll { Collection c -> c.size() > 1 }
for (Collection groupedNodes : declarationsOnSingleLine) {
groupedNodes.sort { it.columnNumber }
addViolationForMultipleDeclarations(groupedNodes)
}
declarations.clear()
super.visitClassComplete(node)
}
private addViolationsForMultipleFieldDeclarations(Collection nodes) {
// all the declarations are on the same line... does the last one have an initial expression and the others do not?
if (nodes[-1].initialExpression != null) {
nodes.remove(nodes[-1]) // remove last node
if (nodes.every { FieldNode f -> f.initialExpression == null }) {
for (def v: nodes) {
addViolation(v, "Confusing declaration in class $currentClassName. The field '$v.name' is initialized to null")
}
}
}
}
private addViolationForMultipleDeclarations(Collection groupedNodes) {
// all the declarations are on the same line... does the last one have an initial expression and the others do not?
def lastExpression = groupedNodes[-1]
if (!(lastExpression.rightExpression instanceof EmptyExpression)) {
groupedNodes.remove(lastExpression) // remove last node b/c it has an expression
for (def declaration: groupedNodes) {
def rhs = declaration.rightExpression
if (rhs instanceof EmptyExpression) {
addViolation(declaration, "Confusing declaration in class $currentClassName. The variable '$declaration.leftExpression.text' is initialized to null")
}
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToOrMethodRule.groovy 0000644 0001750 0001750 00000003030 12141456300 031467 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the or(Object) method is called directly in code instead of using the | operator. A groovier way to express this: a.or(b) is this: a | b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToOrMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToOrMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToOrMethodAstVisitor
boolean ignoreThisReference = true
}
class ExplicitCallToOrMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToOrMethodAstVisitor() {
super('or')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} | ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitHashMapInstantiationRule.groovy 0000644 0001750 0001750 00000002616 12141456710 032753 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* This rule checks for the explicit instantiation of a HashMap using the no-arg constructor.
* In Groovy, it is best to write "new HashMap()" as "[:]", which creates the same object.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class ExplicitHashMapInstantiationRule extends AbstractAstVisitorRule {
String name = 'ExplicitHashMapInstantiation'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ExplicitTypeInstantiationAstVisitor('HashMap') {
@Override
protected String createErrorMessage() {
'HashMap objects are normally instantiated using the form "[:]"'
}
}
}
}
././@LongLink 0000644 0000000 0000000 00000000150 00000000000 011577 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitLinkedHashMapInstantiationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitLinkedHashMapInstantiationRule.gro0000644 0001750 0001750 00000002632 12141456674 033353 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* This rule checks for the explicit instantiation of a LinkedHashMap using the no-arg constructor.
* In Groovy, it is best to write "new LinkedHashMap()" as "[:]", which creates the same object.
*
* @author René Scheibe
*/
class ExplicitLinkedHashMapInstantiationRule extends AbstractAstVisitorRule {
String name = 'ExplicitLinkedHashMapInstantiation'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ExplicitTypeInstantiationAstVisitor('LinkedHashMap') {
@Override
protected String createErrorMessage() {
'LinkedHashMap objects are better instantiated using the form "[:]"'
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ClosureAsLastMethodParameterRule.groovy 0000644 0001750 0001750 00000005015 12006632016 032700 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* If a method is called and the last parameter is an inline closure it can be declared outside of the method call brackets.
*
* @author Marcin Erdmann
* @Chris Mair
*/
class ClosureAsLastMethodParameterRule extends AbstractAstVisitorRule {
String name = 'ClosureAsLastMethodParameter'
int priority = 3
Class astVisitorClass = ClosureAsLastMethodParameterAstVisitor
}
class ClosureAsLastMethodParameterAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
def arguments = AstUtil.getMethodArguments(call)
if (arguments && arguments.last() instanceof ClosureExpression) {
def lastArgument = arguments.last()
def sourceLine = sourceCode.lines[call.lineNumber - 1]
def firstChar = sourceLine[call.columnNumber - 1]
// If a method call is surrounded by parentheses (possibly unnecessary), then the AST includes those in the
// MethodCall start/end column indexes. In that case, it gets too complicated. Just bail.
if (firstChar == '(') {
super.visitMethodCallExpression(call)
return
}
def isViolation = call.lastLineNumber > lastArgument.lastLineNumber ||
(call.lastLineNumber == lastArgument.lastLineNumber &&
call.lastColumnNumber > lastArgument.lastColumnNumber)
if (isViolation) {
addViolation(call, "The last parameter to the '$call.methodAsString' method call is a closure an can appear outside the parenthesis")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToMethodAstVisitor.groovy 0000644 0001750 0001750 00000004266 12311371417 032406 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* Parent Visitor for "ExplicitCallToX" Rules.
*
* @author Hamlet D'Arcy
* @author René Scheibe
*/
abstract class ExplicitCallToMethodAstVisitor extends AbstractMethodCallExpressionVisitor {
final String methodName
/**
* @param methodName The method name to watch for.
*/
protected ExplicitCallToMethodAstVisitor(String methodName) {
this.methodName = methodName
}
void visitMethodCallExpression(MethodCallExpression call) {
if (!AstUtil.isSafe(call) && !AstUtil.isSpreadSafe(call) && AstUtil.isMethodNamed(call, methodName, 1)) {
boolean isAllowedCallOnThis = rule.ignoreThisReference && AstUtil.isMethodCallOnObject(call, 'this')
boolean isAllowedCallOnSuper = AstUtil.isMethodCallOnObject(call, 'super')
if (!isAllowedCallOnThis && !isAllowedCallOnSuper) {
if (!AstUtil.isSafe(call.objectExpression)) {
safelyAddViolation(call)
}
}
}
}
@SuppressWarnings('CatchThrowable')
private safelyAddViolation(MethodCallExpression call) {
try {
addViolation call, getViolationMessage(call)
} catch (Throwable t) {
addViolation call, "Explicit call to $methodName can be simplified using Groovy operator overloading."
}
}
abstract protected String getViolationMessage(MethodCallExpression exp)
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToLeftShiftMethodRule.groovy 0000644 0001750 0001750 00000003124 12141456370 033012 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the leftShift(Object) method is called directly in code instead of using the << operator. A groovier way to express this: a.leftShift(b) is this: a << b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToLeftShiftMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToLeftShiftMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToLeftShiftMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToLeftShiftMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToLeftShiftMethodAstVisitor() {
super('leftShift')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} << ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/CollectAllIsDeprecatedRule.groovy 0000644 0001750 0001750 00000003434 12006632014 031446 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* collectAll is deprecated since Groovy 1.8.1. Use collectNested instead
*
* @author Joachim Baumann
*/
class CollectAllIsDeprecatedRule extends AbstractAstVisitorRule {
String name = 'CollectAllIsDeprecated'
int priority = 2
Class astVisitorClass = CollectAllIsDeprecatedAstVisitor
protected static final String MESSAGE = 'collectAll{} is deprecated since Groovy 1.8.1. Use collectNested instead{}.'
}
class CollectAllIsDeprecatedAstVisitor extends AbstractAstVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
/*
The structure of the AST for this violation is as follows:
MethodCallExpression name collectAll(), one or two parameterStack
*/
if(AstUtil.isMethodCall(call, 'collectAll', 1..2)) {
addViolation(call, CollectAllIsDeprecatedRule.MESSAGE)
}
super.visitMethodCallExpression(call)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitStackInstantiationRule.groovy 0000644 0001750 0001750 00000002620 12141456652 032477 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* This rule checks for the explicit instantiation of a Stack using the no-arg constructor.
* In Groovy, it is best to write "new Stack()" as "[] as Stack", which creates the same object.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class ExplicitStackInstantiationRule extends AbstractAstVisitorRule {
String name = 'ExplicitStackInstantiation'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ExplicitTypeInstantiationAstVisitor('Stack') {
@Override
protected String createErrorMessage() {
'Stack objects are better instantiated using the form "[] as Stack"'
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToCompareToMethodRule.groovy 0000644 0001750 0001750 00000003205 12141456430 033010 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the compareTo(Object) method is called directly in code instead of using the <=>, >, >=, <, and <= operators. A groovier way to express this: a.compareTo(b) is this: a <=> b, or using the other operators.
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToCompareToMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToCompareToMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToCompareToMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToCompareToMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToCompareToMethodAstVisitor() {
super('compareTo')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten using the compareTo operators such as >, <, <=, >=, and <=>"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/UseCollectNestedRule.groovy 0000644 0001750 0001750 00000011262 12041054176 030364 0 ustar ebourg ebourg /*
* Copyright 2012 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.groovyism
import org.apache.log4j.Logger
import org.codehaus.groovy.ast.ClassHelper
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.Parameter
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Instead of nested collect{}-calls use collectNested{}
*
* @author Joachim Baumann
* @author Chris Mair
*/
class UseCollectNestedRule extends AbstractAstVisitorRule {
String name = 'UseCollectNested'
int priority = 2
Class astVisitorClass = UseCollectNestedAstVisitor
protected static final String MESSAGE = 'Instead of nested collect{}-calls use collectNested{}'
}
class UseCollectNestedAstVisitor extends AbstractAstVisitor {
private static final LOG = Logger.getLogger(UseCollectNestedAstVisitor)
private final Stack parameterStack = []
@Override
protected void visitClassComplete(ClassNode cn) {
if (parameterStack.size() != 0) {
LOG.warn("Internal Error for ${cn.name}: Visits are unbalanced")
}
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
boolean isCollectCall = false
Parameter parameter
Parameter it = new Parameter(ClassHelper.OBJECT_TYPE, 'it')
/*
The idea for this rule is to add the parameter of the
closure used in the collect call to the stack of parameters,
and check for each collect expression whether it is called on
the parameter on the top of the stack
*/
if(AstUtil.isMethodCall(call, 'collect', 1..2)) {
Expression expression = getMethodCallParameterThatIsAClosure(call)
isCollectCall = expression instanceof ClosureExpression
if (isCollectCall) {
parameter = getClosureParameter(expression, it)
checkForCallToClosureParameter(call)
}
}
addArgumentList(isCollectCall, parameter)
super.visitMethodCallExpression(call)
removeArgumentList(isCollectCall)
}
private Parameter getClosureParameter(ClosureExpression expression, Parameter it) {
Parameter param
if (expression.parameters.size() != 0) {
// we assume correct syntax and thus only one parameter
param = expression.parameters[0]
}
else {
// implicit parameter, we use our own parameter object as placeholder
param = it
}
return param
}
private Expression getMethodCallParameterThatIsAClosure(MethodCallExpression call) {
int arity = AstUtil.getMethodArguments(call).size()
Expression expression
if (arity == 1) {
// closure is the first parameter
expression = call.arguments.expressions[0]
} else {
// closure is second parameter
expression = call.arguments.expressions[1]
}
return expression
}
private void checkForCallToClosureParameter(MethodCallExpression call) {
// Now if the call is to the parameter of the closure then the node on
// which collect is called has to be a VariableExpression
if (call.objectExpression instanceof VariableExpression
&& !parameterStack.empty()
&& parameterStack.peek().name == call.objectExpression.name) {
addViolation(call, UseCollectNestedRule.MESSAGE)
}
}
private void addArgumentList(boolean isCollectCall, Parameter param) {
if (isCollectCall) {
parameterStack.push(param)
}
}
private void removeArgumentList(boolean isCollectCall) {
if (isCollectCall) {
parameterStack.pop()
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/GroovyLangImmutableRule.groovy 0000644 0001750 0001750 00000005124 12311370173 031104 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codehaus.groovy.ast.AnnotationNode
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.ModuleNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* The groovy.lang.Immutable annotation has been deprecated and replaced by groovy.transform.Immutable. Do not use the
* Immutable in groovy.lang.
*
* @author Hamlet D'Arcy
*/
class GroovyLangImmutableRule extends AbstractAstVisitorRule {
String name = 'GroovyLangImmutable'
int priority = 2
Class astVisitorClass = GroovyLangImmutableAstVisitor
}
class GroovyLangImmutableAstVisitor extends AbstractAstVisitor {
boolean groovyTransformIsStarImported = false
boolean groovyTransformIsImported = false
List aliases = []
@Override
void visitImports(ModuleNode node) {
groovyTransformIsImported = node.imports.any { it.type.name == 'groovy.transform.Immutable' }
groovyTransformIsStarImported = node.starImports.any { it.packageName == 'groovy.transform.' }
aliases = node.imports.findAll { it.type.name == 'groovy.lang.Immutable' && it.alias }*.alias
super.visitImports(node)
}
@Override protected void visitClassComplete(ClassNode node) {
node?.annotations?.each { AnnotationNode anno ->
if (anno?.classNode?.name == 'groovy.lang.Immutable') {
addViolation(anno, 'groovy.lang.Immutable is deprecated in favor of groovy.transform.Immutable')
} else if (anno?.classNode?.name == 'Immutable' && !groovyTransformIsStarImported && !groovyTransformIsImported ) {
addViolation(anno, 'groovy.lang.Immutable is deprecated in favor of groovy.transform.Immutable')
} else if (aliases.contains(anno?.classNode?.name)) {
addViolation(anno, 'groovy.lang.Immutable is deprecated in favor of groovy.transform.Immutable')
}
}
super.visitClassComplete(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/AssignCollectionSortRule.groovy 0000644 0001750 0001750 00000005022 12106561212 031260 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codehaus.groovy.ast.expr.DeclarationExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* The Collections.sort() method mutates the list and returns the list as a value. If you are assigning the result of
* sort() to a variable, then you probably don't realize that you're also modifying the original list as well. This is
* frequently the cause of subtle bugs.
*
* @author Hamlet D'Arcy
*/
class AssignCollectionSortRule extends AbstractAstVisitorRule {
String name = 'AssignCollectionSort'
int priority = 2
Class astVisitorClass = AssignCollectionSortAstVisitor
}
class AssignCollectionSortAstVisitor extends AbstractAstVisitor {
@Override
void visitDeclarationExpression(DeclarationExpression expression) {
Expression right = expression.rightExpression
if (right instanceof MethodCallExpression) {
if (isChainedSort(right) || (isChainedSort(right.objectExpression))) {
addViolation(expression, 'Violation in $currentClassName. sort() mutates the original list, but the return value is being assigned')
}
}
super.visitDeclarationExpression expression
}
private static boolean isChainedSort(Expression expression) {
if (AstUtil.isMethodCall(expression, 'sort', 0..2)) {
def arguments = AstUtil.getMethodArguments(expression)
def isMutateFalse = arguments && AstUtil.isFalse(arguments[0])
if (expression.objectExpression instanceof VariableExpression && !isMutateFalse) {
return true
}
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToModMethodRule.groovy 0000644 0001750 0001750 00000003031 12141456346 031641 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the mod(Object) method is called directly in code instead of using the % operator. A groovier way to express this: a.mod(b) is this: a % b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToModMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToModMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToModMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToModMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToModMethodAstVisitor() {
super('mod')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} % ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToDivMethodRule.groovy 0000644 0001750 0001750 00000003031 12141456422 031637 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the div(Object) method is called directly in code instead of using the / operator. A groovier way to express this: a.div(b) is this: a / b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToDivMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToDivMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToDivMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToDivMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToDivMethodAstVisitor() {
super('div')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} / ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/GetterMethodCouldBePropertyRule.groovy 0000644 0001750 0001750 00000010657 12311373552 032566 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.ClassExpression
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codehaus.groovy.ast.stmt.ReturnStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* If a class defines a public method that follows the Java getter notation and returns a constant,
* then it is cleaner to provide a Groovy property for the value rather than a Groovy method.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class GetterMethodCouldBePropertyRule extends AbstractAstVisitorRule {
String name = 'GetterMethodCouldBeProperty'
int priority = 3
Class astVisitorClass = GetterMethodCouldBePropertyAstVisitor
}
class GetterMethodCouldBePropertyAstVisitor extends AbstractAstVisitor {
private final staticFieldNames = []
@Override
protected void visitClassEx(ClassNode node) {
staticFieldNames.addAll(node.fields.findAll { it.isStatic() }*.name)
super.visitClassEx(node)
}
@Override
protected void visitClassComplete(ClassNode node) {
staticFieldNames.clear()
super.visitClassComplete(node)
}
@Override
protected void visitMethodEx(MethodNode node) {
if (AstUtil.isMethodNode(node, 'get[A-Z].*', 0) && node.isPublic() && AstUtil.isOneLiner(node.code)) {
def statement = node.code.statements[0]
if (statement instanceof ExpressionStatement) {
if (statement.expression instanceof ConstantExpression) {
addViolation(node, createMessage(node))
} else if (statement.expression instanceof VariableExpression && statement.expression.variable ==~ /[A-Z].*/) {
addViolation(node, createMessage(node))
} else if (statement.expression instanceof VariableExpression && staticFieldNames.contains(statement.expression.name)) {
addViolation(node, createMessage(node))
}
} else if (statement instanceof ReturnStatement) {
if (statement.expression instanceof ConstantExpression) {
addViolation(node, createMessage(node))
} else if (statement.expression instanceof ClassExpression) {
addViolation(node, createMessage(node))
} else if (statement.expression instanceof VariableExpression && staticFieldNames.contains(statement.expression.name)) {
addViolation(node, createMessage(node))
}
}
}
super.visitMethodEx(node)
}
private String createMessage(MethodNode node) {
def constant = node.code.statements[0].expression
def methodName = node.name
def methodType = node.returnType.nameWithoutPackage
def staticModifier = node.isStatic() ? 'static ' : ''
def propertyName = node.name[3].toLowerCase() + (node.name.length() == 4 ? '' : node.name[4..-1])
def constantValue
if (constant instanceof ConstantExpression) {
constantValue = constant.value instanceof String ? "'" + constant.value + "'" : constant.value
} else if (constant instanceof ClassExpression) {
constantValue = constant.text
} else if (constant instanceof VariableExpression) {
constantValue = constant.name
} else {
constantValue = ''
}
"The method '$methodName ' in class $currentClassName can be expressed more simply as the field declaration\n" +
"${staticModifier}final $methodType $propertyName = $constantValue"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToPowerMethodRule.groovy 0000644 0001750 0001750 00000003055 12141456262 032221 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the power(Object) method is called directly in code instead of using the ** operator. A groovier way to express this: a.power(b) is this: a ** b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToPowerMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToPowerMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToPowerMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToPowerMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToPowerMethodAstVisitor() {
super('power')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} ** ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToMinusMethodRule.groovy 0000644 0001750 0001750 00000003061 12141456356 032221 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the minus(Object) method is called directly in code instead of using the - operator. A groovier way to express this: a.minus(b) is this: a - b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToMinusMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToMinusMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToMinusMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToMinusMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToMinusMethodAstVisitor() {
super('minus')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} - ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/GStringExpressionWithinStringRule.groovy 0000644 0001750 0001750 00000010610 12465005511 033161 0 ustar ebourg ebourg /*
* Copyright 2013 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.groovyism
import org.codehaus.groovy.ast.AnnotatedNode
import org.codehaus.groovy.ast.AnnotationNode
import org.codehaus.groovy.ast.expr.AnnotationConstantExpression
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.ListExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import java.util.regex.Matcher
/**
* Check for regular (single quote) strings containing a GString-type expression (${..}).
*
* @author Chris Mair
*/
class GStringExpressionWithinStringRule extends AbstractAstVisitorRule {
String name = 'GStringExpressionWithinString'
int priority = 2
Class astVisitorClass = GStringExpressionWithinStringAstVisitor
}
class GStringExpressionWithinStringAstVisitor extends AbstractAstVisitor {
private static final GSTRING_EXPRESSION_REGEX = /\$\{.*\}/
private AnnotatedNode currentAnnotatedNode
@Override
void visitConstantExpression(ConstantExpression expression) {
if (isFirstVisit(expression) && expression.value instanceof String && expression.lineNumber > -1) {
Matcher matcher = expression.value =~ GSTRING_EXPRESSION_REGEX
boolean matchesGStringExpressionPattern = matcher as boolean
if (matchesGStringExpressionPattern && isNotElementOfAnnotation(expression)) {
addViolation(expression, "The String '$expression.value' contains a GString-type expression: '${matcher[0]}'")
}
}
super.visitConstantExpression(expression)
}
@Override
void visitAnnotations(AnnotatedNode node) {
saveCurrentAnnotatedNode(node)
super.visitAnnotations(node)
resetCurrentAnnotatedNode()
}
private boolean isNotElementOfAnnotation(ConstantExpression expression) {
return !isProcessingAnnotatedNode() || !isUsedInAnyAnnotationOnCurrentAnnotatedNode(expression)
}
private boolean isUsedInAnyAnnotationOnCurrentAnnotatedNode(ConstantExpression constantExpression) {
return currentAnnotatedNode.annotations.any { AnnotationNode annotationNode ->
isExpressionUsedInAnnotation(constantExpression, annotationNode)
}
}
private static boolean isExpressionUsedInAnnotation(ConstantExpression expression, AnnotationNode annotationNode) {
List constantExpressions = new ConstantExpressionExtractor().extractFrom(annotationNode)
return constantExpressions.any { it.is(expression) }
}
private boolean isProcessingAnnotatedNode() {
return this.currentAnnotatedNode != null
}
private void resetCurrentAnnotatedNode() {
this.currentAnnotatedNode = null
}
private void saveCurrentAnnotatedNode(AnnotatedNode annotatedNode) {
this.currentAnnotatedNode = annotatedNode
}
}
class ConstantExpressionExtractor {
@SuppressWarnings('UseCollectMany') //collectMany is not available in Groovy 1.7.5
List extractFrom(AnnotationNode annotationNode) {
return annotationNode.members.values().collect {
Expression expression -> extractFromExpression(expression)
}.flatten()
}
private List extractFromExpression(ListExpression listExpression) {
return listExpression.expressions.collect {
Expression expression -> extractFromExpression(expression)
}
}
private List extractFromExpression(ConstantExpression expression) {
return [expression]
}
private List extractFromExpression(AnnotationConstantExpression expression) {
AnnotationNode annotationNode = expression.value as AnnotationNode
return extractFrom(annotationNode)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitLinkedListInstantiationRule.groovy0000644 0001750 0001750 00000002656 12311373552 033501 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
/**
* This rule checks for the explicit instantiation of a LinkedList using the no-arg constructor.
* In Groovy, it is best to write "new LinkedList()" as "[] as Queue", which creates the same object.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class ExplicitLinkedListInstantiationRule extends AbstractAstVisitorRule {
String name = 'ExplicitLinkedListInstantiation'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ExplicitTypeInstantiationAstVisitor('LinkedList') {
@Override
protected String createErrorMessage() {
'LinkedList objects are better instantiated using the form "[] as Queue"'
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/AssignCollectionUniqueRule.groovy 0000644 0001750 0001750 00000004215 12006632012 031576 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codehaus.groovy.ast.expr.DeclarationExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* the unique method mutates the original list. If a user is using the result of this method then they probably don't understand thiss
*
* @author Nick Larson
* @author Juan Vazquez
* @author Jon DeJong
*/
class AssignCollectionUniqueRule extends AbstractAstVisitorRule {
String name = 'AssignCollectionUnique'
int priority = 2
Class astVisitorClass = AssignCollectionUniqueAstVisitor
}
class AssignCollectionUniqueAstVisitor extends AbstractAstVisitor {
@Override
void visitDeclarationExpression(DeclarationExpression expression) {
Expression right = expression.rightExpression
if (right instanceof MethodCallExpression) {
if (isChainedUnique(right) || (isChainedUnique(right.objectExpression))) {
addViolation(expression, 'unique() mutates the original list.')
}
}
super.visitDeclarationExpression expression
}
private static boolean isChainedUnique(Expression right) {
if (AstUtil.isMethodCall(right, 'unique', 0..1)) {
if (right.objectExpression instanceof VariableExpression) {
return true
}
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToPlusMethodRule.groovy 0000644 0001750 0001750 00000003042 12141456270 032043 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the plus(Object) method is called directly in code instead of using the + operator. A groovier way to express this: a.plus(b) is this: a + b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToPlusMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToPlusMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToPlusMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToPlusMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToPlusMethodAstVisitor() {
super('plus')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} + ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToXorMethodRule.groovy 0000644 0001750 0001750 00000003042 12141456242 031667 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the xor(Object) method is called directly in code instead of using the ^ operator. A groovier way to express this: a.xor(b) is this: a ^ b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToXorMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToXorMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToXorMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToXorMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToXorMethodAstVisitor() {
super('xor')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} ^ ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToRightShiftMethodRule.groovy 0000644 0001750 0001750 00000003135 12141456252 033176 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the rightShift(Object) method is called directly in code instead of using the >> operator. A groovier way to express this: a.rightShift(b) is this: a >> b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToRightShiftMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToRightShiftMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToRightShiftMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToRightShiftMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToRightShiftMethodAstVisitor() {
super('rightShift')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} >> ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/GStringAsMapKeyRule.groovy 0000644 0001750 0001750 00000003160 12006632014 030117 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MapEntryExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* A rule that disallows GStrings as map keys as they might change
* their hashcode over time.
* The map keys and values are recursively checked.
*
* @author @Hackergarten
*/
class GStringAsMapKeyRule extends AbstractAstVisitorRule {
String name = 'GStringAsMapKey'
int priority = 2
Class astVisitorClass = GStringAsMapKeyAstVisitor
}
class GStringAsMapKeyAstVisitor extends AbstractAstVisitor {
void visitMapEntryExpression(MapEntryExpression expression) {
if (AstUtil.classNodeImplementsType(expression?.keyExpression?.type, GString)) {
addViolation expression, 'GString as a key in a map is unsafe'
}
super.visitMapEntryExpression expression // needed for GStrings in nested keys and values
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitTypeInstantiationAstVisitor.groovy0000644 0001750 0001750 00000002747 12141456624 033564 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codenarc.rule.AbstractAstVisitor
/**
* AstVisitor that checks for no-arg constructor calls for the type specified in the constructor.
* Used by the ExplicitXxxInstantiation rules.
*
* @author Chris Mair
*/
abstract class ExplicitTypeInstantiationAstVisitor extends AbstractAstVisitor {
private final String typeName
protected ExplicitTypeInstantiationAstVisitor(String typeName) {
this.typeName = typeName
}
void visitConstructorCallExpression(ConstructorCallExpression call) {
if (isFirstVisit(call) && call?.type?.name == typeName && call.arguments.expressions.empty) {
addViolation call, createErrorMessage()
}
super.visitConstructorCallExpression call
}
abstract protected String createErrorMessage()
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToEqualsMethodRule.groovy 0000644 0001750 0001750 00000003165 12141456412 032356 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the equals(Object) method is called directly in code instead of using the == or != operator. A groovier way to express this: a.equals(b) is this: a == b and a groovier way to express : !a.equals(b) is : a != b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToEqualsMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToEqualsMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToEqualsMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToEqualsMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToEqualsMethodAstVisitor() {
super('equals')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as (${exp.objectExpression.text} == ${exp.arguments.text})"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/ExplicitCallToMultiplyMethodRule.groovy 0000644 0001750 0001750 00000003111 12141456334 032735 0 ustar ebourg ebourg /*
* 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.groovyism
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
/**
* This rule detects when the multiply(Object) method is called directly in code instead of using the * operator. A groovier way to express this: a.multiply(b) is this: a * b
*
* @author Hamlet D'Arcy
*/
class ExplicitCallToMultiplyMethodRule extends AbstractAstVisitorRule {
String name = 'ExplicitCallToMultiplyMethod'
int priority = 2
Class astVisitorClass = ExplicitCallToMultiplyMethodAstVisitor
boolean ignoreThisReference = false
}
class ExplicitCallToMultiplyMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
ExplicitCallToMultiplyMethodAstVisitor() {
super('multiply')
}
@Override
protected String getViolationMessage(MethodCallExpression exp) {
"Explicit call to ${exp.text} method can be rewritten as ${exp.objectExpression.text} * ${exp.arguments.text}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/groovyism/UseCollectManyRule.groovy 0000644 0001750 0001750 00000004372 12006632016 030046 0 ustar ebourg ebourg /*
* Copyright 2011 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.groovyism
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* In many case collectMany() yields the same result as collect{}.flatten. It is easier to
* understand and more clearly transports the purpose.
*
* @author Joachim Baumann
*/
class UseCollectManyRule extends AbstractAstVisitorRule {
protected static final String MESSAGE = 'collect{}.flatten() can be collectMany{}'
String name = 'UseCollectMany'
int priority = 2
Class astVisitorClass = UseCollectManyAstVisitor
}
class UseCollectManyAstVisitor extends AbstractAstVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
/*
The structure of the AST for this violation is as follows:
MethodCallExpression name flatten(), no arguments
- objectExpression contains as first element
- MethodCallExpression name collect(), one argument (closure)
Nota Bene: This does not detect assignment to a variable and subsequent call to flatten()
*/
if(AstUtil.isMethodCall(call, 'flatten', 0)) {
// found flatten, now we try to find the previous collect()-call
Expression expression = call.objectExpression
if(AstUtil.isMethodCall(expression, 'collect', 1)) {
addViolation(call, UseCollectManyRule.MESSAGE)
}
}
super.visitMethodCallExpression(call)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/ 0000755 0001750 0001750 00000000000 12623571301 022667 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/InsecureRandomRule.groovy 0000644 0001750 0001750 00000005724 12006632014 027706 0 ustar ebourg ebourg /*
* Copyright 2011 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.security
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Reports usages of java.util.Random, which can produce very predictable results. If two instances of Random are
* created with the same seed and sequence of method calls, they will generate the exact same results. Use
* java.security.SecureRandom instead, which provides a cryptographically strong random number generator.
* SecureRandom uses PRNG, which means they are using a deterministic algorithm to produce a pseudo-random number
* from a true random seed. SecureRandom produces non-deterministic output.
*
* By default, this rule does not apply to test files.
*
* @author Hamlet D'Arcy
*/
class InsecureRandomRule extends AbstractAstVisitorRule {
String name = 'InsecureRandom'
int priority = 2
Class astVisitorClass = InsecureRandomAstVisitor
String doNotApplyToFilesMatching = DEFAULT_TEST_FILES
}
class InsecureRandomAstVisitor extends AbstractAstVisitor {
@Override
void visitConstructorCallExpression(ConstructorCallExpression call) {
if (AstUtil.classNodeImplementsType(call.type, Random)) {
addViolation(call, 'Using Random is insecure. Use SecureRandom instead')
}
super.visitConstructorCallExpression(call)
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, 'Math', 'random', 0)) {
addViolation(call, 'Using Math.random() is insecure. Use SecureRandom instead')
} else if (AstUtil.isMethodNamed(call, 'random', 0) && isJavaLangMathCall(call)) {
addViolation(call, 'Using Math.random() is insecure. Use SecureRandom instead')
}
super.visitMethodCallExpression(call)
}
private static boolean isJavaLangMathCall(MethodCallExpression call) {
if (AstUtil.isPropertyNamed(call.objectExpression, 'Math')) {
if (AstUtil.isPropertyNamed(call.objectExpression.objectExpression, 'lang')) {
if (AstUtil.isVariable(call.objectExpression.objectExpression.objectExpression, 'java')) {
return true
}
}
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/NonFinalPublicFieldRule.groovy 0000644 0001750 0001750 00000002643 12006632016 030576 0 ustar ebourg ebourg /*
* Copyright 2011 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.security
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
/**
* Finds code that violates secure coding principles for mobile code by declaring a member variable public but not final.
*
* @author Hamlet D'Arcy
*/
class NonFinalPublicFieldRule extends AbstractAstVisitorRule {
String name = 'NonFinalPublicField'
int priority = 2
Class astVisitorClass = NonFinalPublicFieldAstVisitor
}
class NonFinalPublicFieldAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (node.isPublic() && !node.isFinal()) {
addViolation(node, "The field $node.name is public but not final, which violates secure coding principles")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/FileCreateTempFileRule.groovy 0000644 0001750 0001750 00000003447 12006632020 030416 0 ustar ebourg ebourg /*
* Copyright 2011 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.security
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* The File.createTempFile() method is insecure, and has been deprecated by the ESAPI secure coding library.
* It has been replaced by the ESAPI Randomizer.getRandomFilename(String) method.
*
* By default, this rule does not apply to test files.
*
* @author Hamlet D'Arcy
*/
class FileCreateTempFileRule extends AbstractAstVisitorRule {
String name = 'FileCreateTempFile'
int priority = 2
Class astVisitorClass = FileCreateTempFileAstVisitor
String doNotApplyToFilesMatching = DEFAULT_TEST_FILES
}
class FileCreateTempFileAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, 'File', 'createTempFile', 2) ||
AstUtil.isMethodCall(call, 'File', 'createTempFile', 3)) {
addViolation(call, 'The method File.createTempFile is insecure. Use a secure API such as that provided by ESAPI')
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/ObjectFinalizeRule.groovy 0000644 0001750 0001750 00000002775 12006632020 027660 0 ustar ebourg ebourg /*
* Copyright 2011 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.security
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* The finalize() method should only be called by the JVM after the object has been garbage collected.
*
* @author 'Hamlet D'Arcy'
*/
class ObjectFinalizeRule extends AbstractAstVisitorRule {
String name = 'ObjectFinalize'
int priority = 2
Class astVisitorClass = ObjectFinalizeAstVisitor
}
class ObjectFinalizeAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodNamed(call, 'finalize', 0)) {
addViolation(call, 'The finalize() method should only be called by the JVM after the object has been garbage collected')
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/SystemExitRule.groovy 0000644 0001750 0001750 00000003027 12006632012 027076 0 ustar ebourg ebourg /*
* Copyright 2011 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.security
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* Web applications should never call System.exit(). A call to System.exit() is probably part of leftover debug code or code imported from a non-J2EE application.
*
* @author 'Hamlet D'Arcy'
*/
class SystemExitRule extends AbstractAstVisitorRule {
String name = 'SystemExit'
int priority = 2
Class astVisitorClass = SystemExitAstVisitor
}
class SystemExitAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, 'System', 'exit', 1)) {
addViolation(call, 'Calling System.exit() is insecure and can expose a denial of service attack')
}
}
}
././@LongLink 0000644 0000000 0000000 00000000151 00000000000 011600 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/NonFinalSubclassOfSensitiveInterfaceRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/NonFinalSubclassOfSensitiveInterfaceRule.gr0000644 0001750 0001750 00000005613 12311370173 033260 0 ustar ebourg ebourg /*
* Copyright 2011 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.security
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
import java.security.BasicPermission
import java.security.Permission
import java.security.PrivilegedAction
import java.security.PrivilegedActionException
/**
* The permissions classes such as java.security.Permission and java.security.BasicPermission are designed to be extended.
* Classes that derive from these permissions classes, however, must prohibit extension. This prohibition ensures that
* malicious subclasses cannot change the properties of the derived class. Classes that implement sensitive interfaces
* such as java.security.PrivilegedAction and java.security.PrivilegedActionException must also be declared final for
* analogous reasons.
*
* @author Hamlet D'Arcy
*/
class NonFinalSubclassOfSensitiveInterfaceRule extends AbstractAstVisitorRule {
String name = 'NonFinalSubclassOfSensitiveInterface'
int priority = 2
Class astVisitorClass = NonFinalSubclassOfSensitiveInterfaceAstVisitor
}
class NonFinalSubclassOfSensitiveInterfaceAstVisitor extends AbstractAstVisitor {
@Override
protected void visitClassEx(ClassNode node) {
if (!Modifier.isFinal(node.modifiers)) {
if (AstUtil.classNodeImplementsType(node, Permission)) {
addViolation(node, "The class $node.nameWithoutPackage extends java.security.Permission but is not final")
} else if (AstUtil.classNodeImplementsType(node, BasicPermission)) {
addViolation(node, "The class $node.nameWithoutPackage extends java.security.BasicPermission but is not final")
} else if (AstUtil.classNodeImplementsType(node, PrivilegedAction)) {
addViolation(node, "The class $node.nameWithoutPackage implements java.security.PrivilegedAction but is not final")
} else if (AstUtil.classNodeImplementsType(node, PrivilegedActionException)) {
addViolation(node, "The class $node.nameWithoutPackage extends java.security.PrivilegedActionException but is not final")
}
}
super.visitClassEx(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/UnsafeArrayDeclarationRule.groovy 0000644 0001750 0001750 00000003713 12311370173 031356 0 ustar ebourg ebourg /*
* Copyright 2011 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.security
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* Triggers a violation when an array is declared public, final, and static. Secure coding principles state that, in most cases, an array declared public, final and static is a bug because arrays are mutable objects.
*
* @author 'Hamlet D'Arcy'
*/
class UnsafeArrayDeclarationRule extends AbstractAstVisitorRule {
String name = 'UnsafeArrayDeclaration'
int priority = 2
Class astVisitorClass = UnsafeArrayDeclarationAstVisitor
}
class UnsafeArrayDeclarationAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (isPublicStaticFinal(node) && isArray(node)) {
addViolation(node, "The Array field $node.name is public, static, and final but still mutable")
}
}
private static boolean isArray(FieldNode node) {
AstUtil.getFieldType(node)?.isArray()
}
private static boolean isPublicStaticFinal(FieldNode node) {
Modifier.isFinal(node.modifiers) &&
Modifier.isStatic(node.modifiers) &&
Modifier.isPublic(node.modifiers)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/PublicFinalizeMethodRule.groovy 0000644 0001750 0001750 00000003067 12041061502 031024 0 ustar ebourg ebourg /*
* Copyright 2011 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.security
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* Creates a violation when the program violates secure coding principles by declaring a finalize() method public.
*
* @author Hamlet D'Arcy
*/
class PublicFinalizeMethodRule extends AbstractAstVisitorRule {
String name = 'PublicFinalizeMethod'
int priority = 2
Class astVisitorClass = PublicFinalizeMethodAstVisitor
}
class PublicFinalizeMethodAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
if (AstUtil.isMethodNode(node, 'finalize', 0) && !Modifier.isProtected(node.modifiers)) {
addViolation(node, 'The finalize() method should only be declared with protected visibility')
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/JavaIoPackageAccessRule.groovy 0000644 0001750 0001750 00000007134 12311370173 030540 0 ustar ebourg ebourg /*
* Copyright 2011 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.security
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* This rule reports violations of the Enterprise JavaBeans specification by using the java.io package to access files or the file system.
*
* @author 'Hamlet D'Arcy'
*/
class JavaIoPackageAccessRule extends AbstractAstVisitorRule {
String name = 'JavaIoPackageAccess'
int priority = 2
Class astVisitorClass = JavaIoPackageAccessAstVisitor
String doNotApplyToFilesMatching = DEFAULT_TEST_FILES
}
class JavaIoPackageAccessAstVisitor extends AbstractAstVisitor {
@Override
void visitConstructorCallExpression(ConstructorCallExpression call) {
if (AstUtil.classNodeImplementsType(call.type, File)) {
def argCount = AstUtil.getMethodArguments(call).size()
if (argCount == 1 || argCount == 2) {
addViolation(call, 'The use of java.io.File violates the Enterprise Java Bean specification')
}
} else if (AstUtil.classNodeImplementsType(call.type, FileOutputStream)) {
def argCount = AstUtil.getMethodArguments(call).size()
if (argCount == 1 || argCount == 2) {
addViolation(call, 'The use of java.io.FileOutputStream violates the Enterprise Java Bean specification')
}
} else if (AstUtil.classNodeImplementsType(call.type, FileReader)) {
def argCount = AstUtil.getMethodArguments(call).size()
if (argCount == 1) {
addViolation(call, 'The use of java.io.FileReader violates the Enterprise Java Bean specification')
}
} else if (AstUtil.classNodeImplementsType(call.type, RandomAccessFile)) {
def argCount = AstUtil.getMethodArguments(call).size()
if (argCount == 2) {
addViolation(call, 'The use of java.io.RandomAccessFile violates the Enterprise Java Bean specification')
}
}
super.visitConstructorCallExpression(call)
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCallOnObject(call, 'FileSystem')) {
addViolation(call, 'The use of java.io.FileSystem violates the Enterprise Java Bean specification')
}
super.visitMethodCallExpression(call)
}
@Override
void visitPropertyExpression(PropertyExpression expression) {
if (expression.objectExpression instanceof VariableExpression) {
if (expression.objectExpression.variable == 'FileSystem') {
addViolation(expression, 'The use of java.io.FileSystem violates the Enterprise Java Bean specification')
}
}
super.visitPropertyExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/security/UnsafeImplementationAsMapRule.groovy 0000644 0001750 0001750 00000005401 12225130172 032032 0 ustar ebourg ebourg /*
* Copyright 2013 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.security
import org.codehaus.groovy.ast.expr.CastExpression
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.MapExpression
import org.codehaus.groovy.control.Phases
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
/**
* Reports incomplete interface implementations created by map-to-interface coercions.
*
* Example:
* [hasNext: { ... }] as Iterator
* (Not all Iterator methods are implemented. An UnsupportedOperationException will be thrown upon call to e.g. next().)
*
* By default, this rule does not apply to test files.
*
* @author Artur Gajowy
*/
class UnsafeImplementationAsMapRule extends AbstractAstVisitorRule {
String name = 'UnsafeImplementationAsMap'
int priority = 2
Class astVisitorClass = UnsafeImplementationAsMapAstVisitor
int compilerPhase = Phases.SEMANTIC_ANALYSIS
String doNotApplyToFilesMatching = DEFAULT_TEST_FILES
}
class UnsafeImplementationAsMapAstVisitor extends AbstractAstVisitor {
@Override
void visitCastExpression(CastExpression cast) {
if (isFirstVisit(cast) && cast.type.isInterface() && cast.expression instanceof MapExpression) {
def interfaceMethods = cast.type.abstractMethods*.name as Set
def implementedMethods = getMethodsImplementedByCoercion(cast.expression)
def unimplementedMethods = (interfaceMethods - implementedMethods).sort()
if (unimplementedMethods) {
addViolation(cast, "Incomplete interface implementation. The following methods of $cast.type.name" +
" are not implemented by this map-to-interface coercion: $unimplementedMethods. Please note that" +
' calling any of these methods on this implementation will cause' +
' an UnsupportedOperationException, which is likely not intended.')
}
}
}
private List getMethodsImplementedByCoercion(MapExpression methodMap) {
List methodNames = methodMap.mapEntryExpressions*.keyExpression.grep(ConstantExpression)
methodNames*.value
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/braces/ 0000755 0001750 0001750 00000000000 12623571301 022257 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/braces/WhileStatementBracesRule.groovy 0000644 0001750 0001750 00000002774 12311373552 030447 0 ustar ebourg ebourg /*
* 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.braces
import org.codehaus.groovy.ast.stmt.WhileStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks that while statements use braces rather than a single statement.
*
* @author Chris Mair
*/
class WhileStatementBracesRule extends AbstractAstVisitorRule {
String name = 'WhileStatementBraces'
int priority = 2
Class astVisitorClass = WhileStatementBracesAstVisitor
}
class WhileStatementBracesAstVisitor extends AbstractAstVisitor {
void visitWhileLoop(WhileStatement whileStatement) {
if (isFirstVisit(whileStatement) && !AstUtil.isBlock(whileStatement.loopBlock)) {
addViolation(whileStatement, 'The while statement lacks braces')
}
super.visitWhileLoop(whileStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/braces/IfStatementBracesRule.groovy 0000644 0001750 0001750 00000002715 12311373552 027730 0 ustar ebourg ebourg /*
* 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.braces
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks that if statements use braces rather than a single statement.
*
* @author Chris Mair
*/
class IfStatementBracesRule extends AbstractAstVisitorRule {
String name = 'IfStatementBraces'
int priority = 2
Class astVisitorClass = IfStatementBracesAstVisitor
}
class IfStatementBracesAstVisitor extends AbstractAstVisitor {
void visitIfElse(IfStatement ifStatement) {
if (isFirstVisit(ifStatement) && !AstUtil.isBlock(ifStatement.ifBlock)) {
addViolation(ifStatement, 'The if statement lacks braces')
}
super.visitIfElse(ifStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/braces/ElseBlockBracesRule.groovy 0000644 0001750 0001750 00000003643 12311373552 027351 0 ustar ebourg ebourg /*
* 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.braces
import org.codehaus.groovy.ast.stmt.EmptyStatement
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks that else blocks use braces rather than a single statement.
*
* By default, braces are not required for an else if it is followed immediately
* by an if. Set the bracesRequiredForElseIf property to true to
* require braces is that situation as well.
*
* @author Chris Mair
*/
class ElseBlockBracesRule extends AbstractAstVisitorRule {
String name = 'ElseBlockBraces'
int priority = 2
boolean bracesRequiredForElseIf = false
Class astVisitorClass = ElseBlockBracesAstVisitor
}
class ElseBlockBracesAstVisitor extends AbstractAstVisitor {
void visitIfElse(IfStatement ifStatement) {
if (isFirstVisit(ifStatement) && !(ifStatement.elseBlock instanceof EmptyStatement) &&
!AstUtil.isBlock(ifStatement.elseBlock)) {
if (!(ifStatement.elseBlock instanceof IfStatement) || rule.bracesRequiredForElseIf) {
addViolation(ifStatement, 'The else block lacks braces')
}
}
super.visitIfElse(ifStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/braces/ForStatementBracesRule.groovy 0000644 0001750 0001750 00000002734 12311373552 030121 0 ustar ebourg ebourg /*
* 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.braces
import org.codehaus.groovy.ast.stmt.ForStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks that for statements use braces rather than a single statement.
*
* @author Chris Mair
*/
class ForStatementBracesRule extends AbstractAstVisitorRule {
String name = 'ForStatementBraces'
int priority = 2
Class astVisitorClass = ForStatementBracesAstVisitor
}
class ForStatementBracesAstVisitor extends AbstractAstVisitor {
void visitForLoop(ForStatement forStatement) {
if (isFirstVisit(forStatement) && !AstUtil.isBlock(forStatement.loopBlock)) {
addViolation(forStatement, 'The for statement lacks braces')
}
super.visitForLoop(forStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/InlineViolationsParser.groovy 0000644 0001750 0001750 00000004663 12236327370 026750 0 ustar ebourg ebourg /*
* Copyright 2013 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
/**
* Parser for inline violation metadata within Rule test classes
*
* @author Artur Gajowy
*/
class InlineViolationsParser {
protected static String inlineViolation(String violationMessage) {
'#' + violationMessage.replaceAll(~/\Q#\E/, /\\#/) + PREVENT_ACCIDENTAL_ESCAPING_OF_NEXT_MARKER
}
private static final String PREVENT_ACCIDENTAL_ESCAPING_OF_NEXT_MARKER = ' '
def result = new ParseResult()
ParseResult parse(String annotatedSource) {
annotatedSource.eachLine(1, this.&parseLine)
result.source = result.source.replaceFirst(~/\n$/, '')
result
}
private void parseLine(String lineWithInlineViolations, int lineNumber) {
def splitByViolationMarkerPattern = lineNumber == 1 ? HASH_NOT_ESCAPED_NOT_PART_OF_SHEBANG : HASH_NOT_ESCAPED
def splitByMarker = lineWithInlineViolations.split(splitByViolationMarkerPattern, KEEP_EMPTY_STRINGS)
def (sourceLine, violationMessages) = [splitByMarker.head(), splitByMarker.tail()]
result.source += sourceLine.replaceAll(~/\s+$/, '') + '\n'
result.violations += violationMessages.collect {
createViolation(lineNumber, sourceLine.trim(), unescape(it.trim()))
}
}
private static final String HASH_NOT_ESCAPED = /(? violations = []
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/jdbc/ 0000755 0001750 0001750 00000000000 12623571301 021722 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/jdbc/DirectConnectionManagementRule.groovy 0000644 0001750 0001750 00000005101 12006632014 031237 0 ustar ebourg ebourg /*
* Copyright 2011 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.jdbc
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* The J2EE standard requires that applications use the container's resource management facilities to obtain
* connections to resources. Every major web application container provides pooled database connection management as
* part of its resource management framework. Duplicating this functionality in an application is difficult and
* error prone, which is part of the reason it is forbidden under the J2EE standard.
*
* @author 'Hamlet D'Arcy'
*/
class DirectConnectionManagementRule extends AbstractAstVisitorRule {
String name = 'DirectConnectionManagement'
int priority = 2
Class astVisitorClass = DirectConnectionManagementAstVisitor
}
class DirectConnectionManagementAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, 'DriverManager', 'getConnection')) {
addViolation(call, 'Using DriverManager.getConnection() violates the J2EE standards. Use the connection from the context instead')
} else if (AstUtil.isMethodNamed(call, 'getConnection') && isJavaSQLDriverManagerCall(call)) {
addViolation(call, 'Using DriverManager.getConnection() violates the J2EE standards. Use the connection from the context instead')
}
}
private static boolean isJavaSQLDriverManagerCall(MethodCallExpression call) {
if (AstUtil.isPropertyNamed(call.objectExpression, 'DriverManager')) {
if (AstUtil.isPropertyNamed(call.objectExpression.objectExpression, 'sql')) {
if (AstUtil.isVariable(call.objectExpression.objectExpression.objectExpression, 'java')) {
return true
}
}
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/jdbc/JdbcConnectionReferenceRule.groovy 0000644 0001750 0001750 00000002320 12006632014 030511 0 ustar ebourg ebourg /*
* Copyright 2011 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.jdbc
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
import org.codenarc.rule.ClassReferenceAstVisitor
/**
* Check for direct use of java.sql.Connection.
*
* Known limitation: Does not catch references as Anonymous Inner class: def x = new java.sql.Connection() { .. }
*
* @author Chris Mair
*/
class JdbcConnectionReferenceRule extends AbstractAstVisitorRule {
String name = 'JdbcConnectionReference'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ClassReferenceAstVisitor('java.sql.Connection')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/jdbc/JdbcResultSetReferenceRule.groovy 0000644 0001750 0001750 00000002455 12006632016 030357 0 ustar ebourg ebourg /*
* Copyright 2011 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.jdbc
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
import org.codenarc.rule.ClassReferenceAstVisitor
/**
* Check for direct use of java.sql.ResultSet, which is not necessary if using the Groovy Sql facility or an
* ORM framework such as Hibernate.
*
* Known limitation: Does not catch references as Anonymous Inner class: def x = new java.sql.ResultSet() { .. }
*
* @author Chris Mair
*/
class JdbcResultSetReferenceRule extends AbstractAstVisitorRule {
String name = 'JdbcResultSetReference'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ClassReferenceAstVisitor('java.sql.ResultSet')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/jdbc/JdbcStatementReferenceRule.groovy 0000644 0001750 0001750 00000002616 12006632016 030370 0 ustar ebourg ebourg /*
* Copyright 2011 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.jdbc
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
import org.codenarc.rule.ClassReferenceAstVisitor
/**
* Check for direct use of java.sql.Statement, PreparedStatement, or CallableStatement, which is not necessary if
* using the Groovy Sql facility or an ORM framework such as Hibernate.
*
* Known limitation: Does not catch references as Anonymous Inner class: def x = new java.sql.Statement() { .. }
*
* @author Chris Mair
*/
class JdbcStatementReferenceRule extends AbstractAstVisitorRule {
String name = 'JdbcStatementReference'
int priority = 2
@Override
AstVisitor getAstVisitor() {
new ClassReferenceAstVisitor('java.sql.Statement, java.sql.PreparedStatement, java.sql.CallableStatement')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/ 0000755 0001750 0001750 00000000000 12623571301 022446 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/SystemErrPrintRule.groovy 0000644 0001750 0001750 00000003025 12311373552 027521 0 ustar ebourg ebourg /*
* 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.logging
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
/**
* Rule that checks for calls to System.err.print(), System.err.println()
* or System.err.printf().
*
* @author Chris Mair
*/
class SystemErrPrintRule extends AbstractAstVisitorRule {
String name = 'SystemErrPrint'
int priority = 2
Class astVisitorClass = SystemErrPrintAstVisitor
}
class SystemErrPrintAstVisitor extends AbstractMethodCallExpressionVisitor {
void visitMethodCallExpression(MethodCallExpression methodCall) {
if (methodCall.text.startsWith('System.err.print')) {
addViolation(methodCall, "System.err.$methodCall.methodAsString should be replaced with something more robust")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/PrintStackTraceRule.groovy 0000644 0001750 0001750 00000003316 12311373552 027613 0 ustar ebourg ebourg /*
* 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.logging
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* Rule that checks for calls to printStackTrace().
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class PrintStackTraceRule extends AbstractAstVisitorRule {
String name = 'PrintStackTrace'
int priority = 2
Class astVisitorClass = PrintStackTraceAstVisitor
}
class PrintStackTraceAstVisitor extends AbstractMethodCallExpressionVisitor {
void visitMethodCallExpression(MethodCallExpression methodCall) {
if (AstUtil.isMethodNamed(methodCall, 'printStackTrace', 0)) {
addViolation(methodCall, 'printStackTrace() should be replaced with something more robust')
}
if (AstUtil.isMethodNamed(methodCall, 'printSanitizedStackTrace', 1)) {
addViolation(methodCall, 'printSanitizedStackTrace() should be replaced with something more robust')
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/LoggerForDifferentClassRule.groovy 0000644 0001750 0001750 00000011511 12311373552 031251 0 ustar ebourg ebourg /*
* Copyright 2011 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.logging
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.InnerClassNode
import org.codehaus.groovy.ast.expr.Expression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
/**
* Rule that checks for instantiating a logger for a class other than the current class. Supports logger
* instantiations for Log4J, Logback, SLF4J, Apache Commons Logging, Java Logging API (java.util.logging).
*
* Limitations:
*
*
Only checks Loggers instantiated within a class field or property (not variables or expressions within a method)
*
For Log4J: Does not catch Logger instantiations if you specify the full package name for the Logger class:
* e.g. org.apache.log4.Logger.getLogger(..)
*
For SLF4J and Logback: Does not catch Log instantiations if you specify the full package name for the LoggerFactory
* class: e.g. org.slf4j.LoggerFactory.getLogger(..)
*
For Commons Logging: Does not catch Log instantiations if you specify the full package name for the LogFactory
* class: e.g. org.apache.commons.logging.LogFactory.getLog(..)
*
For Java Logging API: Does not catch Logger instantiations if you specify the full package name for the Logger
* class: e.g. java.util.logging.Logger.getLogger(..)
*
*
* @author Chris Mair
*/
class LoggerForDifferentClassRule extends AbstractAstVisitorRule {
String name = 'LoggerForDifferentClass'
int priority = 2
boolean allowDerivedClasses = false
Class astVisitorClass = LoggerForDifferentClassAstVisitor
}
class LoggerForDifferentClassAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode fieldNode) {
def expression = fieldNode.getInitialExpression()
if (LogUtil.isMatchingLoggerDefinition(expression)) {
def firstArg = expression.arguments?.expressions?.get(0)
def argText = firstArg.text
final CLASSNAME_WITHOUT_PACKAGE
if (fieldNode.owner instanceof InnerClassNode) {
CLASSNAME_WITHOUT_PACKAGE = fieldNode.owner.nameWithoutPackage - "$fieldNode.owner.outerClass.nameWithoutPackage\$"
} else {
CLASSNAME_WITHOUT_PACKAGE = fieldNode.declaringClass.nameWithoutPackage
}
if (!rule.allowDerivedClasses && isCapitalized(argText) && !isEqualToCurrentClassOrClassName(argText, CLASSNAME_WITHOUT_PACKAGE)) {
addViolation(fieldNode, "Logger is defined in $CLASSNAME_WITHOUT_PACKAGE but initialized with $argText")
} else if (rule.allowDerivedClasses && !isLoggerForDerivedClass(fieldNode)) {
addViolation(fieldNode, "Logger is defined in $CLASSNAME_WITHOUT_PACKAGE but initialized with $argText")
}
}
}
private static boolean isEqualToCurrentClassOrClassName(String argText, classNameWithoutPackage) {
return isEqualToCurrentClass(argText, classNameWithoutPackage) || isEqualToCurrentClassName(argText, classNameWithoutPackage)
}
private static boolean isEqualToCurrentClass(String argText, classNameWithoutPackage) {
return (argText == classNameWithoutPackage) || (argText == classNameWithoutPackage + '.class')
}
private static boolean isLoggerForDerivedClass(FieldNode fieldNode) {
Expression methodArgument = fieldNode.getInitialValueExpression().arguments.expressions.first()
methodArgument.text in ['this.class', 'this.getClass()', 'getClass()']
}
private static boolean isEqualToCurrentClassName(String argText, classNameWithoutPackage) {
def classNameOptions = [
classNameWithoutPackage + '.getClass().getName()',
classNameWithoutPackage + '.getClass().name',
classNameWithoutPackage + '.class.getName()',
classNameWithoutPackage + '.class.name',
classNameWithoutPackage + '.name',
]
return argText in classNameOptions
}
private static boolean isCapitalized(String text) {
def firstCharacter = text[0]
return firstCharacter.toUpperCase() == firstCharacter
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/MultipleLoggersRule.groovy 0000644 0001750 0001750 00000003456 12006632014 027665 0 ustar ebourg ebourg /*
* 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.logging
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
/**
* This rule catches classes that have more than one logger object defined. Typically, a class has zero or one logger objects.
*
* @author 'Hamlet D'Arcy'
*/
class MultipleLoggersRule extends AbstractAstVisitorRule {
String name = 'MultipleLoggers'
int priority = 2
Class astVisitorClass = MultipleLoggersAstVisitor
}
class MultipleLoggersAstVisitor extends AbstractFieldVisitor {
Map> classNodeToFieldNames = [:]
@Override
void visitField(FieldNode fieldNode) {
if (LogUtil.isMatchingLoggerDefinition(fieldNode.getInitialExpression())) {
List logFields = classNodeToFieldNames[fieldNode.declaringClass]
if (logFields) {
logFields.add(fieldNode.name)
addViolation(fieldNode, 'The class defines multiple loggers: ' + logFields.join(', '))
} else {
classNodeToFieldNames[fieldNode.declaringClass] = [fieldNode.name]
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/LoggerWithWrongModifiersRule.groovy 0000644 0001750 0001750 00000005614 12041061504 031476 0 ustar ebourg ebourg /*
* 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.logging
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import java.lang.reflect.Modifier
/**
* Logger objects should be declared private, static and final.
* The exception is, when derived classes should use logger objects. Then they should be declared protected, non-static and final.
* This rule find loggers that are not declared with these modifiers.
*
* @author Hamlet D'Arcy
* @author René Scheibe
*/
class LoggerWithWrongModifiersRule extends AbstractAstVisitorRule {
String name = 'LoggerWithWrongModifiers'
int priority = 2
boolean allowProtectedLogger = false
boolean allowNonStaticLogger = false
Class astVisitorClass = LoggerWithWrongModifiersAstVisitor
}
class LoggerWithWrongModifiersAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode fieldNode) {
if (LogUtil.isMatchingLoggerDefinition(fieldNode.getInitialExpression())) {
int modifiers = fieldNode.modifiers
boolean isPrivate = Modifier.isPrivate(modifiers)
boolean isProtected = Modifier.isProtected(modifiers)
boolean isFinal = Modifier.isFinal(modifiers)
boolean isStatic = Modifier.isStatic(modifiers)
if (!isPrivate && !rule.allowProtectedLogger) {
addViolationForField(fieldNode)
} else if ((!isPrivate && !isProtected) && rule.allowProtectedLogger) {
addViolationForField(fieldNode)
} else if (!isFinal) {
addViolationForField(fieldNode)
} else if (!isStatic && !rule.allowNonStaticLogger) {
addViolationForField(fieldNode)
} else if ((!isPrivate && !isProtected) && rule.allowProtectedLogger) {
addViolationForField(fieldNode)
}
}
}
private addViolationForField(FieldNode fieldNode) {
def visibility = rule.allowProtectedLogger ? 'private (or protected)' : 'private'
def staticness = rule.allowNonStaticLogger ? '' : ', static'
addViolation(fieldNode, "The Logger field $fieldNode.name should be ${visibility}${staticness} and final")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/LogUtil.groovy 0000644 0001750 0001750 00000002055 12006632016 025272 0 ustar ebourg ebourg /*
* Copyright 2011 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.logging
import org.codenarc.util.AstUtil
/**
* Utility methods for Logging rules
* @author Hamlet D'Arcy
*/
class LogUtil {
static boolean isMatchingLoggerDefinition(expression) {
return AstUtil.isMethodCall(expression, 'Logger', 'getLogger', 1) ||
AstUtil.isMethodCall(expression, 'LogFactory', 'getLog', 1) ||
AstUtil.isMethodCall(expression, 'LoggerFactory', 'getLogger', 1)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/LoggingSwallowsStacktraceRule.groovy 0000644 0001750 0001750 00000005556 12006632020 031676 0 ustar ebourg ebourg /*
* 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.logging
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.CatchStatement
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* If you are logging an exception then the proper API is to call error(Object, Throwable), which will log the message
* and the exception stack trace. If you call error(Object) then the stacktrace may not be logged.
*
* @author Hamlet D'Arcy
*/
class LoggingSwallowsStacktraceRule extends AbstractAstVisitorRule {
String name = 'LoggingSwallowsStacktrace'
int priority = 2
Class astVisitorClass = LoggingSwallowsStacktraceAstVisitor
}
class LoggingSwallowsStacktraceAstVisitor extends AbstractAstVisitor {
Map> classNodeToLoggerNames = [:]
@Override
void visitField(FieldNode fieldNode) {
if (LogUtil.isMatchingLoggerDefinition(fieldNode.getInitialExpression())) {
List logFields = classNodeToLoggerNames[fieldNode.declaringClass]
if (logFields) {
logFields.add(fieldNode.name)
} else {
classNodeToLoggerNames[fieldNode.declaringClass] = [fieldNode.name]
}
}
super.visitField(fieldNode)
}
@Override
void visitCatchStatement(CatchStatement statement) {
if (currentClassNode && statement.code instanceof BlockStatement) {
List loggerNames = classNodeToLoggerNames[currentClassNode]
def expressions = statement.code.statements.findAll {
it instanceof ExpressionStatement && it.expression instanceof MethodCallExpression
}
expressions*.expression.each { MethodCallExpression it ->
if (AstUtil.isMethodCall(it, loggerNames, ['error'], 1)) {
addViolation(it, 'The error logging may hide the stacktrace from the exception named ' + statement.variable.name)
}
}
}
super.visitCatchStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/SystemOutPrintRule.groovy 0000644 0001750 0001750 00000002755 12311373552 027551 0 ustar ebourg ebourg /*
* 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.logging
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
/**
* Rule that checks for calls to System.out.print(), System.out.println()
* or System.out.printf().
*
* @author Chris Mair
*/
class SystemOutPrintRule extends AbstractAstVisitorRule {
String name = 'SystemOutPrint'
int priority = 2
Class astVisitorClass = SystemOutPrintAstVisitor
}
class SystemOutPrintAstVisitor extends AbstractMethodCallExpressionVisitor {
void visitMethodCallExpression(MethodCallExpression methodCall) {
if (methodCall.text.startsWith('System.out.print')) {
addViolation(methodCall, "System.out.$methodCall.methodAsString should be replaced with something more robust")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/logging/PrintlnRule.groovy 0000644 0001750 0001750 00000005454 12311373552 026205 0 ustar ebourg ebourg /*
* 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.logging
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for calls to this.print(), this.println()
* or this.printf().
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class PrintlnRule extends AbstractAstVisitorRule {
String name = 'Println'
int priority = 2
Class astVisitorClass = PrintlnAstVisitor
}
class PrintlnAstVisitor extends AbstractAstVisitor {
boolean printlnMethodDefined = false
boolean printlnClosureDefined = false
@Override
protected void visitClassEx(ClassNode node) {
printlnMethodDefined = node?.methods?.any { MethodNode it ->
it.name == 'println' || it.name == 'print'
}
printlnClosureDefined = node?.fields?.any { FieldNode it ->
AstUtil.isClosureDeclaration(it) && (it.name == 'println' || it.name == 'print')
}
}
@Override protected void visitClassComplete(ClassNode node) {
printlnMethodDefined = false
printlnClosureDefined = false
}
@SuppressWarnings('DuplicateLiteral')
void visitMethodCallExpression(MethodCallExpression methodCall) {
if (printlnMethodDefined || printlnClosureDefined) {
return
}
if (isFirstVisit(methodCall)) {
def isMatch =
AstUtil.isMethodCall(methodCall, 'this', 'println', 0) ||
AstUtil.isMethodCall(methodCall, 'this', 'println', 1) ||
AstUtil.isMethodCall(methodCall, 'this', 'print', 1) ||
(AstUtil.isMethodCall(methodCall, 'this', 'printf') && AstUtil.getMethodArguments(methodCall).size() > 1)
if (isMatch) {
addViolation(methodCall, 'println should be replaced with something more robust')
}
}
super.visitMethodCallExpression(methodCall)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/ 0000755 0001750 0001750 00000000000 12623571301 021772 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/CrapMetricRule.groovy 0000644 0001750 0001750 00000015130 12311373552 026124 0 ustar ebourg ebourg /*
* Copyright 2012 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.apache.log4j.Logger
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
import org.codenarc.util.io.DefaultResourceFactory
import org.gmetrics.metric.coverage.CoberturaLineCoverageMetric
import org.gmetrics.metric.crap.CrapMetric
/**
* Rule that calculates the CRAP Metric for methods/classes and checks against
* configured threshold values.
*
* Note that this rule requires the GMetrics 0.5 (or later) jar on the classpath, as well as
* a Cobertura XML coverage file. If either of these prerequisites is not available, this rule
* logs a warning messages and exits (i.e., does nothing).
*
* The coberturaXmlFile property must be set to the path to the Cobertura XML coverage file
* for the Groovy code being analyzed. By default, the path is relative to the classpath. But the path
* may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from
* a relative or absolute path on the filesystem), or "http:". This property is REQUIRED.
*
* The maxMethodCrapScore property holds the threshold value for the CRAP crapMetric
* value for each method. If this value is non-zero, a method with a CRAP score value greater than
* this value is considered a violation. The maxMethodCrapScore property defaults to 30.
*
* The maxClassAverageCrapScore property holds the threshold value for the average CRAP
* crapMetric value for each class. If this value is non-zero, a class with an average CRAP score
* value greater than this value is considered a violation. The maxMethodAverageCrapScore property
* defaults to 30.
*
* The maxClassCrapScore property holds the threshold value for the total CRAP
* crapMetric value for each class. If this value is non-zero, a class with a total CRAP score
* value greater than this value is considered a violation. The maxClassCrapScore 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 does NOT treat "closure fields" as methods (unlike some of the other size/complexity rules).
*
* @see The original 2007 blog post that defined the CRAP crapMetric.
* @see A 2011 blog post from Alberto Savoia, describing the formula, the motivation, and the CRAP4J tool.
* @see GMetrics CRAP crapMetric.
*
* @author Chris Mair
*/
class CrapMetricRule extends AbstractAstVisitorRule {
private static final LOG = Logger.getLogger(CrapMetricRule)
String name = 'CrapMetric'
int priority = 2
BigDecimal maxMethodCrapScore = 30
BigDecimal maxClassAverageMethodCrapScore = 30
BigDecimal maxClassCrapScore = 0
String coberturaXmlFile
String ignoreMethodNames
protected String crapMetricClassName = 'org.gmetrics.metric.crap.CrapMetric'
private Boolean ready
private crapMetric // omit CrapMetric type; it may not be on the classpath
private final readyLock = new Object()
private final createMetricLock = new Object()
private final resourceFactory = new DefaultResourceFactory()
@Override
AstVisitor getAstVisitor() {
return new CrapMetricAstVisitor(createCrapMetric())
}
@Override
boolean isReady() {
synchronized(readyLock) {
if (ready == null) {
ready = true
if (!doesCoberturaXmlFileExist()) {
LOG.warn("The Cobertura XML file [$coberturaXmlFile] is not accessible; skipping this rule")
ready = false
}
if (!isCrapMetricClassOnClasspath()) {
LOG.warn('The GMetrics CrapMetric class is not on the classpath; skipping this rule')
ready = false
}
}
}
return ready
}
private boolean doesCoberturaXmlFileExist() {
if (!coberturaXmlFile) {
return false
}
def resource = resourceFactory.getResource(coberturaXmlFile)
return resource.exists()
}
private createCrapMetric() { // omit CrapMetric type; it may not be on the classpath
synchronized(createMetricLock) {
if (!crapMetric) {
def coverageMetric = new CoberturaLineCoverageMetric(coberturaFile:coberturaXmlFile)
crapMetric = new CrapMetric(coverageMetric:coverageMetric)
}
}
return crapMetric
}
private boolean isCrapMetricClassOnClasspath() {
try {
getClass().classLoader.loadClass(crapMetricClassName)
return true
}
catch (ClassNotFoundException e) {
return false
}
}
}
class CrapMetricAstVisitor extends AbstractMethodMetricAstVisitor {
final String metricShortDescription = 'CRAP score'
private final CrapMetric crapMetric
protected CrapMetricAstVisitor(CrapMetric crapMetric) {
this.crapMetric = crapMetric
}
@Override
protected Object createMetric() {
return crapMetric
}
@Override
protected Object getMaxMethodMetricValue() {
rule.maxMethodCrapScore
}
@Override
protected Object getMaxClassAverageMethodMetricValue() {
rule.maxClassAverageMethodCrapScore
}
protected Object getMaxClassMetricValue() {
rule.maxClassCrapScore
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/AbcComplexityRule.groovy 0000644 0001750 0001750 00000007750 12311373552 026647 0 ustar ebourg ebourg /*
* 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.abc.AbcMetric
/**
* Rule that calculates the ABC Complexity for methods/classes and checks against
* configured threshold values.
*
* The maxMethodComplexity property holds the threshold value for the ABC complexity value
* (magnitude) 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 value does not have to be an integer (i.e., 1.7 is allowed). The
* maxMethodComplexity property defaults to 60.
*
* The maxClassAverageMethodComplexity property holds the threshold value for the average ABC
* complexity value for each class. If this value is non-zero, a class with an average ABC complexity
* value greater than this value is considered a violation. The value does not have to be an integer
* (i.e., 1.7 is allowed). The maxClassAverageMethodComplexity property defaults to 60.
*
* The maxClassComplexity property holds the threshold value for the total ABC
* complexity value for each class. If this value is non-zero, a class with a total ABC complexity
* value greater than this value is considered a violation. The value does not have to be an integer
* (i.e., 1.7 is allowed). 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 ABC Metric specification.
* @see Blog post describing guidelines for interpreting an ABC score.
* @see GMetrics ABC metric.
*
* @deprecated This rule is deprecated and disabled (enabled=false) by default. Use AbcMetric rule instead.
*
* @author Chris Mair
*/
class AbcComplexityRule extends AbstractAstVisitorRule {
String name = 'AbcComplexity'
int priority = 2
Class astVisitorClass = AbcComplexityAstVisitor
int maxMethodComplexity = 60
int maxClassAverageMethodComplexity = 60
int maxClassComplexity = 0
String ignoreMethodNames
AbcComplexityRule() {
this.enabled = false // deprecated; disabled by default
}
}
class AbcComplexityAstVisitor extends AbstractMethodMetricAstVisitor {
final String metricShortDescription = 'ABC score'
protected Object createMetric() {
new AbcMetric()
}
protected Object getMaxMethodMetricValue() {
rule.maxMethodComplexity
}
protected Object getMaxClassAverageMethodMetricValue() {
rule.maxClassAverageMethodComplexity
}
protected Object getMaxClassMetricValue() {
rule.maxClassComplexity
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/MethodCountRule.groovy 0000644 0001750 0001750 00000002716 12006632012 026320 0 ustar ebourg ebourg /*
* 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.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find
* a way to have more fine-grained objects.
*
* @author Tomasz Bujok
* @author Hamlet D'Arcy
*/
class MethodCountRule extends AbstractAstVisitorRule {
String name = 'MethodCount'
int priority = 2
Class astVisitorClass = MethodCountAstVisitor
int maxMethods = 30
}
class MethodCountAstVisitor extends AbstractAstVisitor {
void visitClassEx(ClassNode node) {
if (node.methods?.size() > rule.maxMethods) {
addViolation(node, "Class $node.name has ${node.methods?.size()} methods")
}
super.visitClassEx(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/NestedBlockDepthRule.groovy 0000644 0001750 0001750 00000012045 12311373553 027260 0 ustar ebourg ebourg /*
* 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.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.stmt.*
/**
* Rule that checks for blocks or closures nested more than a configured maximum number.
* Blocks include if, for, while, switch, try, catch, finally and synchronized
* blocks/statements, as well as closures.
*
* The maxNestedBlockDepth property holds the threshold value for the maximum number of
* nesting levels. A block or closures nested deeper than that number of levels is considered a
* violation. The maxNestedBlockDepth property defaults to 3.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class NestedBlockDepthRule extends AbstractAstVisitorRule {
String name = 'NestedBlockDepth'
int priority = 2
int maxNestedBlockDepth = 5
String ignoreRegex = '.*(b|B)uilder'
Class astVisitorClass = NestedBlockDepthAstVisitor
}
class NestedBlockDepthAstVisitor extends AbstractAstVisitor {
private final Set blocksToProcess = []
private Set closureFieldExpressions
private nestedBlockDepth = 0
void visitClassEx(ClassNode classNode) {
addClosureFields(classNode)
super.visitClassEx(classNode)
}
private void addClosureFields(ClassNode classNode) {
closureFieldExpressions = []
classNode.fields.each { fieldNode ->
if (!AstUtil.isFromGeneratedSourceCode(fieldNode) &&
fieldNode.initialExpression instanceof ClosureExpression) {
closureFieldExpressions << fieldNode.initialExpression
}
}
}
void visitBlockStatement(BlockStatement block) {
if (isFirstVisit(block) && block in blocksToProcess) {
handleNestedNode(block) { super.visitBlockStatement(block) }
}
else {
super.visitBlockStatement(block)
}
}
void visitTryCatchFinally(TryCatchStatement tryCatchStatement) {
addBlockIfNotEmpty(tryCatchStatement.tryStatement)
addBlockIfNotEmpty(tryCatchStatement.finallyStatement)
super.visitTryCatchFinally(tryCatchStatement)
}
void visitCatchStatement(CatchStatement statement) {
handleNestedNode(statement) { super.visitCatchStatement(statement) }
}
private void addBlockIfNotEmpty(block) {
if (!(block instanceof EmptyStatement)) {
blocksToProcess << block
}
}
void visitIfElse(IfStatement ifStatement) {
if (isFirstVisit(ifStatement)) {
addBlockIfNotEmpty(ifStatement.ifBlock)
addBlockIfNotEmpty(ifStatement.elseBlock)
}
super.visitIfElse(ifStatement)
}
void visitWhileLoop(WhileStatement whileStatement) {
handleNestedNode(whileStatement) { super.visitWhileLoop(whileStatement) }
}
void visitForLoop(ForStatement forStatement) {
handleNestedNode(forStatement) { super.visitForLoop(forStatement) }
}
void visitCaseStatement(CaseStatement statement) {
handleNestedNode(statement) { super.visitCaseStatement(statement) }
}
void visitSynchronizedStatement(SynchronizedStatement statement) {
handleNestedNode(statement) { super.visitSynchronizedStatement(statement) }
}
void visitClosureExpression(ClosureExpression expression) {
if (closureFieldExpressions.contains(expression)) {
super.visitClosureExpression(expression)
}
else {
handleNestedNode(expression) { super.visitClosureExpression(expression) }
}
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (!AstUtil.isMethodCallOnObject(call, rule.ignoreRegex)
&& !AstUtil.isConstructorCall(call.objectExpression, rule.ignoreRegex)) {
super.visitMethodCallExpression(call)
}
}
private void handleNestedNode(node, Closure callVisitorMethod) {
nestedBlockDepth++
if (nestedBlockDepth > rule.maxNestedBlockDepth) {
addViolation(node, "The nested block depth is $nestedBlockDepth")
}
callVisitorMethod()
nestedBlockDepth--
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/ClassSizeRule.groovy 0000644 0001750 0001750 00000004071 12467526132 026003 0 ustar ebourg ebourg /*
* 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.size
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.Violation
import org.codenarc.util.AstUtil
/**
* Rule that checks the size of a class.
*
* The maxLines property holds the threshold value for the maximum number of lines. A
* class length (number of lines) greater than that value is considered a violation. The
* maxLines property defaults to 1000.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class ClassSizeRule extends AbstractAstVisitorRule {
String name = 'ClassSize'
int priority = 3
Class astVisitorClass = ClassSizeAstVisitor
int maxLines = 1000
}
class ClassSizeAstVisitor extends AbstractAstVisitor {
void visitClassEx(ClassNode classNode) {
if (!AstUtil.isFromGeneratedSourceCode(classNode)) {
def numLines = classNode.lastLineNumber - classNode.lineNumber + 1
if (numLines > rule.maxLines) {
def className = classNode.name
def classNameNoPackage = className[(className.lastIndexOf('.') + 1) .. -1]
violations.add(new Violation(rule:rule, lineNumber:classNode.lineNumber,
message:"""Class "$classNameNoPackage" is $numLines lines"""))
}
}
super.visitClassEx(classNode)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/ParameterCountRule.groovy 0000644 0001750 0001750 00000004341 12444433061 027025 0 ustar ebourg ebourg /*
* Copyright 2014 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.codehaus.groovy.ast.ConstructorNode
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
/**
* Checks if the number of parameters in method/constructor exceeds the number of parameters
* specified by the maxParameters property.
*
* @author Maciej Ziarko
*/
class ParameterCountRule extends AbstractAstVisitorRule {
private static final DEFAULT_MAX_PARAMETER = 5
String name = 'ParameterCount'
int priority = 2
Class astVisitorClass = ParameterCountAstVisitor
int maxParameters = DEFAULT_MAX_PARAMETER
void setMaxParameters(int maxParameters) {
if (maxParameters < 1) {
throw new IllegalArgumentException("maxParameters property of $name rule must be a positive integer!")
}
this.maxParameters = maxParameters
}
}
class ParameterCountAstVisitor extends AbstractAstVisitor {
@Override
protected void visitConstructorOrMethod(MethodNode node, boolean isConstructor) {
checkParametersCount(node)
}
private void checkParametersCount(MethodNode node) {
if (node.parameters.size() > rule.maxParameters) {
addViolation(node, "Number of parameters in ${getName(node)} exceeds maximum allowed (${rule.maxParameters}).")
}
}
private String getName(MethodNode methodNode) {
return "method ${methodNode.declaringClass.name}.${methodNode.name}"
}
private String getName(ConstructorNode constructorNode) {
return "constructor of class ${constructorNode.declaringClass.name}"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/MethodSizeRule.groovy 0000644 0001750 0001750 00000004735 12413643352 026160 0 ustar ebourg ebourg /*
* 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.size
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.Violation
import org.codenarc.util.WildcardPattern
/**
* Rule that checks the size of a method.
*
* The maxLines property holds the threshold value for the maximum number of lines. A
* method length (number of lines) greater than that value is considered a violation. The
* maxLines property defaults to 100.
*
* 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 '?').
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class MethodSizeRule extends AbstractAstVisitorRule {
String name = 'MethodSize'
int priority = 3
Class astVisitorClass = MethodSizeAstVisitor
int maxLines = 100
String ignoreMethodNames
}
class MethodSizeAstVisitor extends AbstractAstVisitor {
void visitConstructorOrMethod(MethodNode methodNode, boolean isConstructor) {
if (methodNode.lineNumber >= 0) {
def numLines = methodNode.lastLineNumber - methodNode.lineNumber + 1
if (numLines > rule.maxLines && !isIgnoredMethodName(methodNode)) {
def methodName = methodNode.name
violations.add(new Violation(rule:rule, lineNumber:methodNode.lineNumber, message:"""Method "$methodName" is $numLines lines"""))
}
}
super.visitConstructorOrMethod(methodNode, isConstructor)
}
private boolean isIgnoredMethodName(MethodNode node) {
new WildcardPattern(rule.ignoreMethodNames, false).matches(node.name)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/GMetricsSourceCodeAdapter.groovy 0000644 0001750 0001750 00000003250 12006632016 030227 0 ustar ebourg ebourg /*
* 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.codehaus.groovy.ast.ModuleNode
import org.gmetrics.source.SourceCode
/**
* Adapter that adapts from a GMetrics SourceCode object to a CodeNarc SourceCode object.
*
* @author Chris Mair
*/
class GMetricsSourceCodeAdapter implements SourceCode {
private final codeNarcSourceCode
GMetricsSourceCodeAdapter(org.codenarc.source.SourceCode sourceCode) {
assert sourceCode
codeNarcSourceCode = sourceCode
}
String getName() {
codeNarcSourceCode.name
}
String getPath() {
codeNarcSourceCode.path
}
String getText() {
codeNarcSourceCode.text
}
List getLines() {
codeNarcSourceCode.lines
}
String line(int lineNumber) {
codeNarcSourceCode.line(lineNumber)
}
ModuleNode getAst() {
codeNarcSourceCode.ast
}
int getLineNumberForCharacterIndex(int charIndex) {
codeNarcSourceCode.getLineNumberForCharacterIndex(charIndex)
}
boolean isValid() {
return codeNarcSourceCode.isValid()
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/AbstractMethodMetricAstVisitor.groovy 0000644 0001750 0001750 00000012101 12311373552 031336 0 ustar ebourg ebourg /*
* Copyright 2012 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.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.Violation
import org.codenarc.util.AstUtil
import org.codenarc.util.WildcardPattern
import org.gmetrics.metric.Metric
/**
* Abstract superclass for AstVisitor classes that use method-level GMetrics Metrics.
*
* Subclasses must:
*
*
Implement the abstract createMetric() method
*
Implement the abstract getMetricShortDescription() method
*
Implement the abstract getMaxMethodMetricValue() method
*
Implement the abstract getMaxClassAverageMethodMetricValue() method
*
The owning Rule class must have the ignoreMethodNames property
*
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
@SuppressWarnings('DuplicateLiteral')
abstract class AbstractMethodMetricAstVisitor extends AbstractAstVisitor {
protected Metric metric
private final metricLock = new Object()
protected abstract createMetric()
protected abstract String getMetricShortDescription()
protected abstract Object getMaxMethodMetricValue()
protected abstract Object getMaxClassMetricValue()
protected abstract Object getMaxClassAverageMethodMetricValue()
private Metric getMetric() {
synchronized(metricLock) {
if (metric == null) {
metric = createMetric()
}
return metric
}
}
void visitClassEx(ClassNode classNode) {
def gmetricsSourceCode = new GMetricsSourceCodeAdapter(this.sourceCode)
def classMetricResult = getMetric().applyToClass(classNode, gmetricsSourceCode)
if (classMetricResult == null) { // no methods or closure fields
return
}
checkMethods(classMetricResult)
if (!AstUtil.isFromGeneratedSourceCode(classNode)) {
if (!(classNode.isScript() && classNode.name == 'None')) {
checkClass(classMetricResult, classNode)
}
}
super.visitClassEx(classNode)
}
private void checkMethods(classMetricResult) {
def methodResults = classMetricResult.methodMetricResults
methodResults.each { method, results ->
String methodName = extractMethodName(method)
if (results['total'] > getMaxMethodMetricValue() && !isIgnoredMethodName(methodName)) {
def message = "Violation in class $currentClassName. The ${getMetricShortDescription()} for method [$methodName] is [${results['total']}]"
addViolation(results, message)
}
}
}
protected String extractMethodName(method) {
// For GMetrics 0.4, it is a String; For GMetrics 0.5 it is a MethodKey
method instanceof String ? method : method.methodName
}
private void checkClass(classMetricResult, classNode) {
def className = classNode.name
def classResults = classMetricResult.classMetricResult
if (getMaxClassAverageMethodMetricValue() && classResults['average'] > getMaxClassAverageMethodMetricValue()) {
def message = "The average method ${getMetricShortDescription()} for class [$className] is [${classResults['average']}]"
addViolation(classResults, message)
}
if (getMaxClassMetricValue() && classResults['total'] > getMaxClassMetricValue()) {
def message = "The total class ${getMetricShortDescription()} for class [$className] is [${classResults['total']}]"
addViolation(classResults, message)
}
}
protected void addViolation(classResults, String message) {
def lineNumber = getLineNumber(classResults)
def sourceLine = getSourceLine(lineNumber)
violations.add(new Violation(rule:rule, lineNumber:lineNumber, sourceLine:sourceLine, message:message))
}
protected getLineNumber(methodResults) {
def lineNumber = AstUtil.respondsTo(methodResults, 'getLineNumber') ? methodResults.getLineNumber() : null
(lineNumber == -1) ? null : lineNumber
}
protected String getSourceLine(lineNumber) {
lineNumber == null ?: this.sourceCode.line(lineNumber - 1)
}
protected boolean isIgnoredMethodName(String methodName) {
new WildcardPattern(rule.ignoreMethodNames, false).matches(methodName)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/AbcMetricRule.groovy 0000644 0001750 0001750 00000007247 12055544272 025742 0 ustar ebourg ebourg /*
* Copyright 2012 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.abc.AbcMetric
/**
* Rule that calculates the ABC metric score for methods/classes and checks against
* configured threshold values.
*
* The maxMethodAbcScore property holds the threshold value for the ABC score
* (magnitude) for each method. If this value is non-zero, a method with an ABC score greater than
* this value is considered a violation. The value does not have to be an integer (i.e., 1.7 is allowed). The
* maxMethodAbcScore property defaults to 60.
*
* The maxClassAverageMethodAbcScore property holds the threshold value for the average ABC
* score for each class. If this value is non-zero, a class with an average ABC score
* greater than this value is considered a violation. The value does not have to be an integer
* (i.e., 1.7 is allowed). The maxClassAverageMethodAbcScore property defaults to 60.
*
* The maxClassAbcScore property holds the threshold value for the total ABC
* score value for each class. If this value is non-zero, a class with a total ABC score
* greater than this value is considered a violation. The value does not have to be an integer
* (i.e., 1.7 is allowed). The maxClassAbcScore 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 ABC Metric specification.
* @see Blog post describing guidelines for interpreting an ABC score.
* @see GMetrics ABC metric.
*
* @author Chris Mair
*/
class AbcMetricRule extends AbstractAstVisitorRule {
String name = 'AbcMetric'
int priority = 2
Class astVisitorClass = AbcMetricAstVisitor
int maxMethodAbcScore = 60
int maxClassAverageMethodAbcScore = 60
int maxClassAbcScore = 0
String ignoreMethodNames
}
class AbcMetricAstVisitor extends AbstractMethodMetricAstVisitor {
final String metricShortDescription = 'ABC score'
protected Object createMetric() {
new AbcMetric()
}
protected Object getMaxMethodMetricValue() {
rule.maxMethodAbcScore
}
protected Object getMaxClassAverageMethodMetricValue() {
rule.maxClassAverageMethodAbcScore
}
protected Object getMaxClassMetricValue() {
rule.maxClassAbcScore
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/size/CyclomaticComplexityRule.groovy 0000644 0001750 0001750 00000007310 12311373552 030241 0 ustar ebourg ebourg /*
* 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.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'
protected Object createMetric() {
new CyclomaticComplexityMetric()
}
protected Object getMaxMethodMetricValue() {
rule.maxMethodComplexity
}
protected Object getMaxClassAverageMethodMetricValue() {
rule.maxClassAverageMethodComplexity
}
protected Object getMaxClassMetricValue() {
rule.maxClassComplexity
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/imports/ 0000755 0001750 0001750 00000000000 12623571301 022515 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/imports/UnusedImportRule.groovy 0000644 0001750 0001750 00000006212 12277665572 027276 0 ustar ebourg ebourg /*
* Copyright 2008 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.imports
import org.codehaus.groovy.ast.ImportNode
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
import org.codenarc.util.GroovyVersion
/**
* Rule that checks for an unreferenced import
*
* @author Chris Mair
*/
class UnusedImportRule extends AbstractRule {
String name = 'UnusedImport'
int priority = 3
void applyTo(SourceCode sourceCode, List violations) {
processImports(sourceCode, violations)
processStaticImports(sourceCode, violations)
}
private void processImports(SourceCode sourceCode, List violations) {
sourceCode.ast?.imports?.each { importNode ->
if (!findReference(sourceCode, importNode.alias, importNode.className)) {
violations.add(createViolationForImport(sourceCode, importNode, "The [${importNode.className}] import is never referenced"))
}
}
}
private void processStaticImports(SourceCode sourceCode, List violations) {
if (GroovyVersion.isGroovy1_8_OrGreater()) {
sourceCode.ast?.staticImports?.each { alias, ImportNode classNode ->
if (!findReference(sourceCode, alias)) {
violations.add(createViolationForImport(sourceCode, classNode.className, alias, "The [${classNode.className}] import is never referenced"))
}
}
} else {
sourceCode.ast?.staticImportAliases?.each { alias, classNode ->
if (!findReference(sourceCode, alias)) {
violations.add(createViolationForImport(sourceCode, classNode.name, alias, "The [${classNode.name}] import is never referenced"))
}
}
}
}
private findReference(SourceCode sourceCode, String alias, String className = null) {
def aliasSameAsNonQualifiedClassName = className && className.endsWith(alias)
sourceCode.lines.find { line ->
if (!isImportStatementForAlias(line, alias)) {
def aliasCount = countUsage(line, alias)
return aliasSameAsNonQualifiedClassName ?
aliasCount && aliasCount > countUsage(line, className) : aliasCount
}
}
}
private isImportStatementForAlias(String line, String alias) {
final IMPORT_PATTERN = /import\s+.*/ + alias
line =~ IMPORT_PATTERN
}
private countUsage(String line, String pattern) {
(line =~ /\b${pattern}\b/).count
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/imports/NoWildcardImportsRule.groovy 0000644 0001750 0001750 00000002335 12311373552 030225 0 ustar ebourg ebourg /*
* Copyright 2014 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.imports
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
/**
* Wildcard imports, static or otherwise, are not used.
*
* @author Kyle Boon
*/
class NoWildcardImportsRule extends AbstractImportRule {
String name = 'NoWildcardImports'
int priority = 3
void applyTo(SourceCode sourceCode, List violations) {
eachImportLine(sourceCode) { int lineNumber, String line ->
if (line.trim().endsWith('.*')) {
violations.add(new Violation(rule: this, sourceLine: line.trim(), lineNumber: lineNumber))
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/imports/UnnecessaryGroovyImportRule.groovy 0000644 0001750 0001750 00000004054 12311373552 031521 0 ustar ebourg ebourg /*
* Copyright 2011 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.imports
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
import org.codenarc.util.AstUtil
import org.codenarc.util.ImportUtil
/**
* Rule that checks for non-static imports from any packages that are
* automatically imported by Groovy, including:
*
*
java.io
*
java.lang
*
java.net
*
java.util
*
java.math.BigDecimal
*
java.math.BigInteger
*
groovy.lang
*
groovy.util
*
*
* @author Chris Mair
*/
class UnnecessaryGroovyImportRule extends AbstractRule {
String name = 'UnnecessaryGroovyImport'
int priority = 3
void applyTo(SourceCode sourceCode, List violations) {
if (sourceCode.ast?.imports || sourceCode.ast?.starImports) {
ImportUtil.getNonStaticImportsSortedByLineNumber(sourceCode).each { importNode ->
def importClassName = importNode.className
def importPackageName = ImportUtil.packageNameForImport(importNode)
if ((!importNode.alias || importClassName.endsWith(".$importNode.alias")) &&
(importPackageName in AstUtil.AUTO_IMPORTED_PACKAGES || importClassName in AstUtil.AUTO_IMPORTED_CLASSES)) {
violations.add(createViolationForImport(sourceCode, importNode))
}
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/imports/MisorderedStaticImportsRule.groovy 0000644 0001750 0001750 00000004211 12006632014 031427 0 ustar ebourg ebourg /*
* Copyright 2011 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.imports
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
/**
* Static imports should be before nonstatic imports
*
* @author Erik Pragt
* @author Marcin Erdmann
* @author Hamlet D'Arcy
*/
class MisorderedStaticImportsRule extends AbstractImportRule {
private static final String COMES_BEFORE_MESSAGE = 'Static imports should appear before normal imports'
private static final String COMES_AFTER_MESSAGE = 'Normal imports should appear before static imports'
String name = 'MisorderedStaticImports'
int priority = 3
boolean comesBefore = true
void applyTo(SourceCode sourceCode, List violations) {
if (comesBefore) {
violations.addAll addOrderingViolations(sourceCode, NON_STATIC_IMPORT_PATTERN, STATIC_IMPORT_PATTERN, COMES_BEFORE_MESSAGE)
} else {
violations.addAll addOrderingViolations(sourceCode, STATIC_IMPORT_PATTERN, NON_STATIC_IMPORT_PATTERN, COMES_AFTER_MESSAGE)
}
}
private addOrderingViolations(SourceCode sourceCode, String earlyPattern, String latePattern, String message) {
List violations = []
boolean nonStaticFound = false
eachImportLine(sourceCode) { int lineNumber, String line ->
nonStaticFound = nonStaticFound || line =~ earlyPattern
if (nonStaticFound && line =~ latePattern) {
violations << new Violation(rule: this, sourceLine: line.trim(), lineNumber: lineNumber, message: message)
}
}
violations
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/imports/ImportFromSamePackageRule.groovy 0000644 0001750 0001750 00000004233 12311373552 031000 0 ustar ebourg ebourg /*
* Copyright 2008 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.imports
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
import org.codenarc.util.ImportUtil
/**
* Checks for an import of a class that is within the same package as the importing class.
*
* @author Chris Mair
*/
@SuppressWarnings('DuplicateLiteral')
class ImportFromSamePackageRule extends AbstractRule {
String name = 'ImportFromSamePackage'
int priority = 3
void applyTo(SourceCode sourceCode, List violations) {
def hasImports = sourceCode.ast?.imports || sourceCode.ast?.starImports
if (hasImports && sourceCode.ast.packageName) {
def rawPackage = sourceCode.ast.packageName
def filePackageName = rawPackage.endsWith('.') ? rawPackage[0..-2] : rawPackage
ImportUtil.getNonStaticImportsSortedByLineNumber(sourceCode).each { importNode ->
def importPackageName = ImportUtil.packageNameForImport(importNode)
if (importPackageName == filePackageName && !hasAlias(importNode)) {
violations.add(createViolationForImport(sourceCode, importNode))
}
}
}
}
private boolean hasAlias(importNode) {
importNode.className && importNode.alias != getClassNameNoPackage(importNode.className)
}
private String getClassNameNoPackage(String className) {
def indexOfLastPeriod = className.lastIndexOf('.')
(indexOfLastPeriod == -1) ? className : className[indexOfLastPeriod + 1..-1]
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/imports/ImportFromSunPackagesRule.groovy 0000644 0001750 0001750 00000004064 12006632012 031033 0 ustar ebourg ebourg /*
* Copyright 2011 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.imports
import org.codehaus.groovy.ast.ImportNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.source.SourceCode
/**
* Avoid importing anything from the 'sun.*' packages. These packages are not portable and are likely to change.
*
* @author 'Hamlet D'Arcy'
*/
class ImportFromSunPackagesRule extends AbstractAstVisitorRule {
String name = 'ImportFromSunPackages'
int priority = 2
void applyTo(SourceCode sourceCode, List violations) {
sourceCode.ast?.imports?.each { importNode ->
addViolationForSunImport(importNode, sourceCode, violations)
}
sourceCode.ast?.starImports?.each { importNode ->
addViolationForSunImport(importNode, sourceCode, violations)
}
}
def addViolationForSunImport(ImportNode importNode, SourceCode sourceCode, List violations) {
def className = importNode.className
def packageName = importNode.packageName
if (className?.startsWith('sun.')) {
String message = "The file imports $className, which is not portable and likely to change"
violations.add(createViolationForImport(sourceCode, importNode, message))
} else if (packageName?.startsWith('sun.')) {
String message = "The file imports ${packageName}*, which is not portable and likely to change"
violations.add(createViolationForImport(sourceCode, importNode, message))
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/imports/AbstractImportRule.groovy 0000644 0001750 0001750 00000003722 12006632016 027552 0 ustar ebourg ebourg /*
* Copyright 2008 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.imports
import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
/**
* Abstract class with common functionalities for import-related rules.
*
* @author Erik Pragt
* @author Marcin Erdmann
*/
abstract class AbstractImportRule extends AbstractRule {
public static final NON_STATIC_IMPORT_PATTERN = /^\s*import(?!\s+static)\s+(\w+(\.\w+)*)\b.*/
public static final STATIC_IMPORT_PATTERN = /^\s*import\s+static\s+(\w+(\.\w+)*)\b.*/
/**
* Optimization: Stop checking lines for imports once a class/interface has been declared
*/
protected findLineNumberOfFirstClassDeclaration(SourceCode sourceCode) {
int firstLineNumber = sourceCode.lines.size()
def ast = sourceCode.ast
ast?.classes.each { classNode ->
if (classNode.lineNumber >= 0 && classNode.lineNumber < firstLineNumber) {
firstLineNumber = classNode.lineNumber
}
}
firstLineNumber
}
protected void eachImportLine(SourceCode sourceCode, Closure closure) {
int firstClassDeclarationLine = findLineNumberOfFirstClassDeclaration(sourceCode)
for(int index=0; index < firstClassDeclarationLine; index++) {
def line = sourceCode.lines[index]
def lineNumber = index + 1
closure.call(lineNumber, line)
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/imports/DuplicateImportRule.groovy 0000644 0001750 0001750 00000004770 12311373552 027733 0 ustar ebourg ebourg /*
* Copyright 2008 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.imports
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
/**
* Rule that checks for a duplicate import
*
* NOTE: Does not distinguish between multiple duplicate imports of the same class.
* Thus, it may produce multiple violations with the same line number in that case.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class DuplicateImportRule extends AbstractImportRule {
String name = 'DuplicateImport'
int priority = 3
void applyTo(SourceCode sourceCode, List violations) {
def importNames = [] as Set
def staticImportNames = [] as Set
eachImportLine(sourceCode) { int lineNumber, String line ->
checkImport(line, lineNumber, importNames, violations)
checkStaticImport(line, lineNumber, staticImportNames, violations)
}
}
private void checkImport(line, lineNumber, importNames, violations) {
def importMatcher = line =~ NON_STATIC_IMPORT_PATTERN
if (importMatcher) {
def importName = importMatcher[0][1]
if (importNames.contains(importName)) {
violations.add(new Violation(rule: this, sourceLine: line.trim(), lineNumber: lineNumber))
}
else {
importNames.add(importName)
}
}
}
private void checkStaticImport(line, lineNumber, staticImportNames, violations) {
def importMatcher = line =~ STATIC_IMPORT_PATTERN
if (importMatcher) {
def staticImportName = importMatcher[0][1]
if (staticImportNames.contains(staticImportName)) {
violations.add(new Violation(rule: this, sourceLine: line.trim(), lineNumber: lineNumber))
}
else {
staticImportNames.add(staticImportName)
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/AbstractConstructorCallAstVisitor.groovy 0000644 0001750 0001750 00000003514 12311373552 031131 0 ustar ebourg ebourg /*
* 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
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
/**
* Abstract superclass for AST Visitor classes that deal with constructor calls
*
* @author Chris Mair
*/
abstract class AbstractConstructorCallAstVisitor extends AbstractAstVisitor {
/**
* Subclasses must implement to return true if the visited constructor call causes a rule violation
*/
protected abstract isConstructorCallAViolation(ConstructorCallExpression constructorCall)
protected abstract String getViolationMessage(ConstructorCallExpression call)
@SuppressWarnings('CatchThrowable')
@Override
void visitConstructorCallExpression(ConstructorCallExpression constructorCall) {
if (isFirstVisit(constructorCall) && isConstructorCallAViolation(constructorCall)) {
try {
addViolation(constructorCall, getViolationMessage(constructorCall))
} catch (Throwable t) {
addViolation(constructorCall, "Violation in class $currentClassName. The type $constructorCall.type.name can be instantiated with a literal")
}
}
super.visitConstructorCallExpression(constructorCall)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/ 0000755 0001750 0001750 00000000000 12623571301 023352 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/SynchronizedOnGetClassRule.groovy 0000644 0001750 0001750 00000003552 12006632020 032047 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.stmt.SynchronizedStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Synchronized on getClass rather than class literal. This instance method synchronizes on this.getClass(). If this
* class is subclassed, subclasses will synchronize on the class object for the subclass, which isn't likely what was intended.
*
* @author Hamlet D'Arcy
*/
class SynchronizedOnGetClassRule extends AbstractAstVisitorRule {
String name = 'SynchronizedOnGetClass'
int priority = 2
Class astVisitorClass = SynchronizedOnGetClassAstVisitor
}
class SynchronizedOnGetClassAstVisitor extends AbstractAstVisitor {
void visitSynchronizedStatement(SynchronizedStatement statement) {
if (!isFirstVisit(statement)) {
return
}
if (statement.expression instanceof MethodCallExpression && AstUtil.isMethodNamed(statement.expression, 'getClass', 0)) {
addViolation statement, 'Synchronizing on getClass() should be replaced with a class literal'
}
super.visitSynchronizedStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/SynchronizedReadObjectMethodRule.groovy 0000644 0001750 0001750 00000006554 12311373552 033230 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.Parameter
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.Statement
import org.codehaus.groovy.ast.stmt.SynchronizedStatement
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* Catches Serializable classes that define a synchronized readObject method. By definition, an object created by
* deserialization is only reachable by one thread, and thus there is no need for readObject() to be synchronized.
* If the readObject() method itself is causing the object to become visible to another thread, that is an example of
* very dubious coding style.
*
* @author Hamlet D'Arcy
*/
class SynchronizedReadObjectMethodRule extends AbstractAstVisitorRule {
String name = 'SynchronizedReadObjectMethod'
int priority = 2
Class astVisitorClass = SynchronizedReadObjectMethodAstVisitor
}
class SynchronizedReadObjectMethodAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
def classNode = getCurrentClassNode()
if (isSerializable(classNode) && AstUtil.isMethodNode(node, 'readObject', 1)
&& Modifier.isPrivate(node.modifiers)) {
Parameter parm = node.parameters[0]
if (node?.returnType?.name == 'void' && AstUtil.classNodeImplementsType(parm.type, ObjectInputStream)) {
if (Modifier.isSynchronized(node.modifiers)) {
addViolation(node, "The Serializable class $classNode.name has a synchronized readObject method. It is normally unnecesary to synchronize within deserializable")
} else if (isSynchronizedBlock(node.code)) {
addViolation(node.code, "The Serializable class $classNode.name has a synchronized readObject method. It is normally unnecesary to synchronize within deserializable")
}
}
}
}
private static isSerializable(ClassNode node) {
boolean isSerializable = false
node.interfaces?.each {
if (AstUtil.classNodeImplementsType(it, Serializable)) {
isSerializable = true
}
}
isSerializable
}
private static boolean isSynchronizedBlock(Statement statement) {
if (!(statement instanceof BlockStatement)) {
return false
}
if (statement.statements.size() != 1) {
return false
}
statement.statements[0] instanceof SynchronizedStatement
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/BusyWaitRule.groovy 0000644 0001750 0001750 00000004602 12006632016 027216 0 ustar ebourg ebourg /*
* Copyright 2011 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.concurrency
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codehaus.groovy.ast.stmt.ForStatement
import org.codehaus.groovy.ast.stmt.WhileStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Busy waiting (forcing a Thread.sleep() while waiting on a condition) should be avoided. Prefer using the gate and barrier objects in the java.util.concurrent package.
*
* @author Hamlet D'Arcy
*/
class BusyWaitRule extends AbstractAstVisitorRule {
String name = 'BusyWait'
int priority = 2
Class astVisitorClass = BusyWaitAstVisitor
}
class BusyWaitAstVisitor extends AbstractAstVisitor {
@Override
void visitWhileLoop(WhileStatement node) {
addViolationIfBusyWait(node)
super.visitWhileLoop(node)
}
@Override
void visitForLoop(ForStatement node) {
// -1 is line number for a for-each loop
if (node.variable.lineNumber == -1) {
addViolationIfBusyWait(node)
}
super.visitForLoop(node)
}
private addViolationIfBusyWait(node) {
if (node.loopBlock instanceof BlockStatement
&& node.loopBlock.statements?.size() == 1
&& node.loopBlock.statements[0] instanceof ExpressionStatement) {
Expression expression = node.loopBlock.statements[0].expression
if (AstUtil.isMethodCall(expression, 'sleep', 1) || AstUtil.isMethodCall(expression, 'sleep', 2)) {
addViolation(expression, 'Busy wait detected. Switch the usage of Thread.sleep() to a lock or gate from java.util.concurrent')
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/InconsistentPropertyLockingRule.groovy 0000644 0001750 0001750 00000010257 12141451430 033205 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
/**
* Class contains similarly-named get and set methods where one method of the pair is marked either @WithReadLock or @WithWriteLock and the other is not locked at all.
*
* @author 'Hamlet D'Arcy'
*/
class InconsistentPropertyLockingRule extends AbstractAstVisitorRule {
String name = 'InconsistentPropertyLocking'
int priority = 2
Class astVisitorClass = InconsistentPropertyLockingAstVisitor
}
class InconsistentPropertyLockingAstVisitor extends AbstractMethodVisitor {
private final Map guardedMethods = [:]
private final Map unguardedMethods = [:]
@Override
void visitMethod(MethodNode node) {
if (node.name.startsWith('get') && node.name.size() > 3 && AstUtil.getParameterNames(node).isEmpty()) {
// is a getter
def propName = node.name[3..-1]
saveMethodInfo(node)
addViolationOnMismatch(node.name, "set$propName")
}
if (node.name.startsWith('is') && node.name.size() > 2 && AstUtil.getParameterNames(node).isEmpty()) {
// is a getter
def propName = node.name[2..-1]
saveMethodInfo(node)
addViolationOnMismatch(node.name, "set$propName")
}
if (node.name.startsWith('set') && node.name.size() > 3 && AstUtil.getParameterNames(node).size() == 1) {
// is a setter
def propName = node.name[3..-1]
saveMethodInfo(node)
addViolationOnMismatch("get$propName", node.name)
addViolationOnMismatch("is$propName", node.name)
}
}
private saveMethodInfo(MethodNode node) {
if (isWriteLocked(node) || isReadLocked(node)) {
guardedMethods.put(node.name, node)
} else {
unguardedMethods.put(node.name, node)
}
}
private void addViolationOnMismatch(String getterName, String setterName) {
if (guardedMethods.containsKey(getterName) && unguardedMethods.containsKey(setterName)) {
MethodNode unguardedNode = unguardedMethods.get(setterName)
MethodNode guardedNode = guardedMethods.get(getterName)
def lockType = getGuardName(guardedNode)
addViolation(unguardedNode, "The getter method $getterName is marked @$lockType but the setter method $setterName is not locked")
}
if (unguardedMethods.containsKey(getterName) && guardedMethods.containsKey(setterName)) {
MethodNode unguardedNode = unguardedMethods.get(getterName)
MethodNode guardedNode = guardedMethods.get(setterName)
def lockType = getGuardName(guardedNode)
addViolation(unguardedNode, "The setter method $setterName is marked @$lockType but the getter method $getterName is not locked")
}
}
private static String getGuardName(MethodNode guardedNode) {
if (isWriteLocked(guardedNode)) {
return 'WithWriteLock'
}
if (isReadLocked(guardedNode)) {
return 'WithReadLock'
}
''
}
private static boolean isWriteLocked(MethodNode node) {
AstUtil.getAnnotation(node, 'WithWriteLock') || AstUtil.getAnnotation(node, 'groovy.transform.WithWriteLock')
}
private static boolean isReadLocked(MethodNode node) {
AstUtil.getAnnotation(node, 'WithReadLock') || AstUtil.getAnnotation(node, 'groovy.transform.WithReadLock')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/SynchronizedOnStringRule.groovy 0000644 0001750 0001750 00000003417 12006632016 031615 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.SynchronizedStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Synchronization on a String field can lead to deadlock because Strings are interned by the JVM and can be shared.
*
* @author Hamlet D'Arcy
*/
class SynchronizedOnStringRule extends AbstractAstVisitorRule {
String name = 'SynchronizedOnString'
int priority = 2
Class astVisitorClass = SynchronizedOnStringAstVisitor
}
class SynchronizedOnStringAstVisitor extends AbstractAstVisitor {
@Override
void visitSynchronizedStatement(SynchronizedStatement statement) {
if (statement.expression instanceof VariableExpression) {
if (AstUtil.getFieldType(currentClassNode, statement.expression.variable) == String) {
addViolation(statement, "Synchronizing on the constant String field $statement.expression.variable is unsafe. Do not synchronize on interned strings")
}
}
super.visitSynchronizedStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/SynchronizedOnReentrantLockRule.groovy 0000644 0001750 0001750 00000004004 12041061500 033104 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.SynchronizedStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import java.util.concurrent.locks.ReentrantLock
/**
* Synchronizing on a ReentrantLock field is almost never the intended usage. A ReentrantLock should be obtained using the lock() method and released in a finally block using the unlock() method.
*
* @author 'Hamlet D'Arcy'
*/
class SynchronizedOnReentrantLockRule extends AbstractAstVisitorRule {
String name = 'SynchronizedOnReentrantLock'
int priority = 2
Class astVisitorClass = SynchronizedOnReentrantLockAstVisitor
}
class SynchronizedOnReentrantLockAstVisitor extends AbstractAstVisitor {
@Override
void visitSynchronizedStatement(SynchronizedStatement statement) {
if (statement.expression instanceof VariableExpression) {
if (AstUtil.getFieldType(currentClassNode, statement.expression.variable) == ReentrantLock) {
addViolation(statement, "Synchronizing on a ReentrantLock field $statement.expression.variable. This is almost never the intended usage; use the lock() and unlock() methods instead")
}
}
super.visitSynchronizedStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/NestedSynchronizationRule.groovy 0000644 0001750 0001750 00000004506 12006632012 032012 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codehaus.groovy.ast.stmt.SynchronizedStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.Violation
/**
* Rule to detect nested synchronization blocks.
*
* @author Hamlet D'Arcy
*/
class NestedSynchronizationRule extends AbstractAstVisitorRule {
String name = 'NestedSynchronization'
int priority = 2
Class astVisitorClass = NestedSynchronizationAstVisitor
}
class NestedSynchronizationAstVisitor extends AbstractAstVisitor {
private int visitCount = 0
void visitSynchronizedStatement(SynchronizedStatement statement) {
if (isFirstVisit(statement)) {
if (visitCount > 0) {
addViolation(statement, 'Nested synchronized statements are confusing and may lead to deadlock')
}
visitCount++
super.visitSynchronizedStatement(statement)
visitCount--
} else {
super.visitSynchronizedStatement(statement)
}
}
void visitClosureExpression(ClosureExpression expression) {
if (isFirstVisit(expression)) {
// dispatch to a new instance b/c we have a new scope
AbstractAstVisitor newVisitor = new NestedSynchronizationAstVisitor(sourceCode: this.sourceCode, rule: this.rule, visited: this.visited)
expression.getCode().visit(newVisitor)
newVisitor.getViolations().each { Violation it ->
addViolation(it)
}
} else {
super.visitClosureExpression(expression)
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/StaticConnectionRule.groovy 0000644 0001750 0001750 00000003355 12311370173 030724 0 ustar ebourg ebourg /*
* Copyright 2011 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.concurrency
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
import java.sql.Connection
/**
* Creates violations when a java.sql.Connection object is used as a static field. Database connections stored in static fields will be shared between threads, which is unsafe and can lead to race conditions.
*
* @author 'Hamlet D'Arcy'
*/
class StaticConnectionRule extends AbstractAstVisitorRule {
String name = 'StaticConnection'
int priority = 2
Class astVisitorClass = StaticConnectionAstVisitor
}
class StaticConnectionAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (AstUtil.classNodeImplementsType(node.type, Connection) && Modifier.isStatic(node.modifiers)) {
addViolation(node, "The field $node.name is marked static, meaning the Connection will be shared between threads and will possibly experience race conditions")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/UseOfNotifyMethodRule.groovy 0000644 0001750 0001750 00000003221 12006632020 031011 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* This code calls notify() rather than notifyAll(). Java monitors are often used for multiple conditions. Calling
* notify() only wakes up one thread, meaning that the thread woken up might not be the one waiting for the condition
* that the caller just satisfied.
*
* @author Hamlet D'Arcy
*/
class UseOfNotifyMethodRule extends AbstractAstVisitorRule {
String name = 'UseOfNotifyMethod'
int priority = 2
Class astVisitorClass = UseOfNotifyMethodAstVisitor
}
class UseOfNotifyMethodAstVisitor extends AbstractMethodCallExpressionVisitor {
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodNamed(call, 'notify', 0)) {
addViolation call, "The method $call.text should be replaced with ${call.objectExpression.text}.notifyAll()"
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/ThreadYieldRule.groovy 0000644 0001750 0001750 00000003030 12311371417 027643 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* Method calls to Thread.yield() should not be allowed.
* This method has no useful guaranteed semantics, and is often used by inexperienced
* programmers to mask race conditions.
*
* @author Hamlet D'Arcy
*/
class ThreadYieldRule extends AbstractAstVisitorRule {
String name = 'ThreadYield'
int priority = 2
Class astVisitorClass = ThreadYieldAstVisitor
}
class ThreadYieldAstVisitor extends AbstractMethodCallExpressionVisitor {
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, 'Thread', 'yield', 0)) {
addViolation(call, 'Thread.yield() has not useful guaranteed semantics')
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/SystemRunFinalizersOnExitRule.groovy 0000644 0001750 0001750 00000003502 12006632016 032574 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* Method calls to System.runFinalizersOnExit() should not be allowed. This method is inherently
* non-thread-safe, may result in data corruption, deadlock, and may effect parts of the program
* far removed from it's call point. It is deprecated, and it's use strongly discouraged.
*
* @author Hamlet D'Arcy
*/
class SystemRunFinalizersOnExitRule extends AbstractAstVisitorRule {
String name = 'SystemRunFinalizersOnExit'
int priority = 2
Class astVisitorClass = SystemRunFinalizersOnExitAstVisitor
}
class SystemRunFinalizersOnExitAstVisitor extends AbstractMethodCallExpressionVisitor {
void visitMethodCallExpression(MethodCallExpression call) {
if (call.objectExpression instanceof VariableExpression) {
if (AstUtil.isMethodCall(call, 'System', 'runFinalizersOnExit', 1)) {
addViolation(call, 'System.runFinalizersOnExit() should not be invoked')
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/VolatileArrayFieldRule.groovy 0000644 0001750 0001750 00000003313 12311370173 031171 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* Volatile array fields are unsafe because the contents of the array are not treated as volatile. Changing the entire array reference is visible to other threads, but changing an array element is not.
*
* @author Hamlet D'Arcy
*/
class VolatileArrayFieldRule extends AbstractAstVisitorRule {
String name = 'VolatileArrayField'
int priority = 2
Class astVisitorClass = VolatileArrayFieldAstVisitor
}
class VolatileArrayFieldAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (Modifier.isVolatile(node.modifiers) && AstUtil.getFieldType(node)?.isArray()) {
addViolation(node, "The array field $node.name is marked volatile, but the contents of the array will not share the same volatile semantics. Use a different data type")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/StaticSimpleDateFormatFieldRule.groovy 0000644 0001750 0001750 00000004636 12041061500 032763 0 ustar ebourg ebourg /*
* Copyright 2011 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.concurrency
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
import java.text.SimpleDateFormat
/**
* SimpleDateFormat objects should not be used as static fields. SimpleDateFormat are inherently unsafe for
* multi-threaded use. Sharing a single instance across thread boundaries without proper synchronization will
* result in erratic behavior of the application.
*
* @author Chris Mair
*/
class StaticSimpleDateFormatFieldRule extends AbstractAstVisitorRule {
String name = 'StaticSimpleDateFormatField'
int priority = 2
Class astVisitorClass = StaticSimpleDateFormatFieldAstVisitor
}
class StaticSimpleDateFormatFieldAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (Modifier.isStatic(node.modifiers) && AstUtil.classNodeImplementsType(node.type, SimpleDateFormat)) {
addSimpleDateFormatViolation(node, node.name)
}
else {
if (Modifier.isStatic(node.modifiers) && node.initialValueExpression && isSimpleDateFormatConstructorCall(node.initialValueExpression)) {
addSimpleDateFormatViolation(node, node.name)
}
}
}
private static boolean isSimpleDateFormatConstructorCall(expression) {
AstUtil.isConstructorCall(expression, ['SimpleDateFormat', 'java.text.SimpleDateFormat'])
}
private void addSimpleDateFormatViolation(node, String fieldName) {
addViolation(node, "SimpleDateFormat instances are not thread safe. Wrap the SimpleDateFormat field $fieldName in a ThreadLocal or make it an instance field")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/ThreadLocalNotStaticFinalRule.groovy 0000644 0001750 0001750 00000003650 12041054200 032426 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import java.lang.reflect.Modifier
/**
* ThreadLocal fields should be static and final. In the most common case a java.lang.ThreadLocal
* instance associates state with a thread. A non-static non-final java.lang.ThreadLocal field
* associates state with an instance-thread combination. This is seldom necessary and often a
* bug which can cause memory leaks and possibly incorrect behavior.
*
* @author Hamlet D'Arcy
*/
class ThreadLocalNotStaticFinalRule extends AbstractAstVisitorRule {
String name = 'ThreadLocalNotStaticFinal'
int priority = 2
Class astVisitorClass = ThreadLocalNotStaticFinalAstVisitor
}
class ThreadLocalNotStaticFinalAstVisitor extends AbstractFieldVisitor {
void visitField(FieldNode node) {
if (node?.type?.name == 'ThreadLocal') {
if (!Modifier.isStatic(node.modifiers)) {
addViolation(node, "The ThreadLocal field $node.name is not static")
}
if (!Modifier.isFinal(node.modifiers)) {
addViolation(node, "The ThreadLocal field $node.name is not final")
}
}
}
}
././@LongLink 0000644 0000000 0000000 00000000153 00000000000 011602 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/InconsistentPropertySynchronizationRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/InconsistentPropertySynchronizationRule.0000644 0001750 0001750 00000014544 12462775475 033605 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* Class contains similarly-named get and set methods where the set method is synchronized and the get method is not, or the get method is synchronized and the set method is not.
*
* @author 'Hamlet D'Arcy'
*/
class InconsistentPropertySynchronizationRule extends AbstractAstVisitorRule {
String name = 'InconsistentPropertySynchronization'
int priority = 2
Class astVisitorClass = InconsistentPropertySynchronizationAstVisitor
}
class InconsistentPropertySynchronizationAstVisitor extends AbstractMethodVisitor {
private final Map synchronizedMethods = [:]
private final Map unsynchronizedMethods = [:]
@Override
void visitMethod(MethodNode node) {
if (node.name.startsWith('get') && node.name.size() > 3 && AstUtil.getParameterNames(node).isEmpty()) {
// is a getter
def propName = node.name[3..-1]
saveMethodInfo(node)
// does the enclosing class have this property?
if (AstUtil.classNodeHasProperty(currentClassNode, extractPropertyName(node))) {
addViolationOnMismatch([node.name], "set$propName")
}
}
if (node.name.startsWith('is') && node.name.size() > 2 && AstUtil.getParameterNames(node).isEmpty()) {
// is a getter
def propName = node.name[2..-1]
saveMethodInfo(node)
if (AstUtil.classNodeHasProperty(currentClassNode, extractPropertyName(node))) {
addViolationOnMismatch([node.name], "set$propName")
}
}
if (node.name.startsWith('set') && node.name.size() > 3 && AstUtil.getParameterNames(node).size() == 1) {
// is a setter
def propName = node.name[3..-1]
saveMethodInfo(node)
if (AstUtil.classNodeHasProperty(currentClassNode, extractPropertyName(node))) {
addViolationOnMismatch(["get$propName", "is$propName"], node.name)
}
}
}
private static String extractPropertyName(MethodNode node) {
if (node.name.startsWith('get') || node.name.startsWith('set')) {
if (node.name.length() == 4) {
return node.name[3..-1].toLowerCase()
}
return node.name[3].toLowerCase() + node.name[4..-1]
} else if (node.name.startsWith('is')) {
if (node.name.length() == 3) {
return node.name[2..-1].toLowerCase()
}
return node.name[2].toLowerCase() + node.name[3..-1]
}
throw new IllegalArgumentException("MethodNode $node.name is not a getter/setter/izzer")
}
private saveMethodInfo(MethodNode node) {
if (Modifier.isSynchronized(node.modifiers)) {
synchronizedMethods.put(node.name, node)
} else if (AstUtil.getAnnotation(node, 'Synchronized')) {
synchronizedMethods.put(node.name, node)
} else if (AstUtil.getAnnotation(node, 'groovy.transform.Synchronized')) {
synchronizedMethods.put(node.name, node)
} else {
unsynchronizedMethods.put(node.name, node)
}
}
@SuppressWarnings('CyclomaticComplexity')
private void addViolationOnMismatch(List rawGetterNames, String setterName) {
def getterNames = rawGetterNames*.toString() // force GString into strings
if (containsKey(synchronizedMethods, getterNames) && unsynchronizedMethods.containsKey(setterName)) {
def getterName = getFirstValue(synchronizedMethods, getterNames).name
MethodNode node = unsynchronizedMethods.get(setterName)
addViolation(node, "The getter method $getterName is synchronized but the setter method $setterName is not")
} else if (containsKey(unsynchronizedMethods, getterNames) && synchronizedMethods.containsKey(setterName)) {
def getterName = getFirstValue(unsynchronizedMethods, getterNames).name
MethodNode node = unsynchronizedMethods.get(getterName)
addViolation(node, "The setter method $setterName is synchronized but the getter method $getterName is not")
} else if (containsKey(synchronizedMethods, getterNames)) {
// perhaps the owner didn't define the method
def getterName = getFirstValue(synchronizedMethods, getterNames).name
MethodNode node = synchronizedMethods.get(getterName)
if (!currentClassNode?.methods?.find { it?.name == setterName && it?.parameters?.length == 1 }) {
addViolation(node, "The getter method $getterName is synchronized but the setter method $setterName is not")
}
} else if (synchronizedMethods.containsKey(setterName)) {
// the setter is synchronized, perhaps the getter was never defined?
if (!currentClassNode?.methods?.find { getterNames.contains(it?.name) && it?.parameters?.length == 0 }) {
MethodNode node = synchronizedMethods.get(setterName)
addViolation(node, "The setter method $setterName is synchronized but the getter method ${getterNames.size() == 1 ? getterNames[0] : getterNames} is not")
}
}
}
private static boolean containsKey(Map methodList, List keys) {
methodList.find { it.key in keys } != null
}
private static MethodNode getFirstValue(Map methodList, List keys) {
methodList.find { it.key in keys }.value
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/StaticDateFormatFieldRule.groovy 0000644 0001750 0001750 00000005004 12041061500 031577 0 ustar ebourg ebourg /*
* Copyright 2011 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.concurrency
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
import java.text.DateFormat
/**
* DateFormat objects should not be used as static fields. DateFormat are inherently unsafe for multithreaded use. Sharing a
* single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
*
* @author 'Hamlet D'Arcy'
* @author Chris Mair
*/
class StaticDateFormatFieldRule extends AbstractAstVisitorRule {
String name = 'StaticDateFormatField'
int priority = 2
Class astVisitorClass = StaticDateFormatFieldAstVisitor
}
class StaticDateFormatFieldAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (Modifier.isStatic(node.modifiers) && AstUtil.classNodeImplementsType(node.type, DateFormat)) {
addDateFormatViolation(node, node.name)
}
else {
if (Modifier.isStatic(node.modifiers) && node.initialValueExpression && isDateFormatFactoryMethodCall(node.initialValueExpression)) {
addDateFormatViolation(node, node.name)
}
}
}
private static boolean isDateFormatFactoryMethodCall(expression) {
expression instanceof MethodCallExpression &&
AstUtil.isMethodCall(expression, ['DateFormat', /java\.text\.DateFormat/], ['getDateInstance', 'getDateTimeInstance', 'getTimeInstance'])
}
private void addDateFormatViolation(node, String fieldName) {
addViolation(node, "DateFormat instances are not thread safe. Wrap the DateFormat field $fieldName in a ThreadLocal or make it an instance field")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/StaticCalendarFieldRule.groovy 0000644 0001750 0001750 00000004405 12041061500 031266 0 ustar ebourg ebourg /*
* Copyright 2011 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.concurrency
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* Calendar objects should not be used as static fields. Calendars are inherently unsafe for multithreaded use. Sharing
* a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class StaticCalendarFieldRule extends AbstractAstVisitorRule {
String name = 'StaticCalendarField'
int priority = 2
Class astVisitorClass = StaticCalendarFieldAstVisitor
}
class StaticCalendarFieldAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (Modifier.isStatic(node.modifiers) && AstUtil.classNodeImplementsType(node.type, Calendar)) {
addCalendarViolation(node, node.name)
}
else {
if (Modifier.isStatic(node.modifiers) && node.initialValueExpression && isCalendarFactoryMethodCall(node.initialValueExpression)) {
addCalendarViolation(node, node.name)
}
}
}
private static boolean isCalendarFactoryMethodCall(expression) {
AstUtil.isMethodCall(expression, 'Calendar', 'getInstance')
}
private void addCalendarViolation(node, String fieldName) {
addViolation(node, "Calendar instances are not thread safe. Wrap the Calendar field $fieldName in a ThreadLocal or make it an instance field")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/StaticMatcherFieldRule.groovy 0000644 0001750 0001750 00000003411 12041061500 031134 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
import java.util.regex.Matcher
/**
* Matcher objects should not be used as static fields. Calendars are inherently unsafe for multithreaded use. Sharing a
* single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.
*
* @author Hamlet D'Arcy
*/
class StaticMatcherFieldRule extends AbstractAstVisitorRule {
String name = 'StaticMatcherField'
int priority = 2
Class astVisitorClass = StaticMatcherFieldAstVisitor
}
class StaticMatcherFieldAstVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (Modifier.isStatic(node.modifiers) && AstUtil.classNodeImplementsType(node.type, Matcher)) {
addViolation(node, "Matcher instances are not thread safe. Wrap the Matcher field $node.name in a ThreadLocal or make it an instance field")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/VolatileLongOrDoubleFieldRule.groovy 0000644 0001750 0001750 00000003735 12041054202 032446 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.ClassHelper
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import java.lang.reflect.Modifier
/**
* This rule reports long or double fields which are declared as volatile. Java
* specifies that reads and writes from such fields are atomic, but many JVM's
* have violated this specification. Unless you are certain of your JVM, it is
* better to synchronize access to such fields rather than declare them volatile.
*
* @author Hamlet D'Arcy
*/
class VolatileLongOrDoubleFieldRule extends AbstractAstVisitorRule {
String name = 'VolatileLongOrDoubleField'
int priority = 2
Class astVisitorClass = VolatileLongOrDoubleFieldVisitor
}
class VolatileLongOrDoubleFieldVisitor extends AbstractFieldVisitor {
@Override
void visitField(FieldNode node) {
if (node?.type == ClassHelper.double_TYPE ||
node?.type == ClassHelper.long_TYPE ||
node?.type?.name == 'Long' ||
node?.type?.name == 'Double') {
if (Modifier.isVolatile(node.modifiers)) {
addViolation(node, 'Operations on volatile long and double fields are not guaranteed atomic on all JVMs')
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/SynchronizedOnThisRule.groovy 0000644 0001750 0001750 00000003656 12006632016 031263 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.SynchronizedStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Synchronized On This Rule - This rule reports uses of the synchronized blocks where
* the synchronization reference is 'this'. Doing this effectively makes your
* synchronization policy public and modifiable by other objects. To avoid possibilities
* of deadlock, it is better to synchronize on internal objects.
*
* @author Hamlet D'Arcy
*/
class SynchronizedOnThisRule extends AbstractAstVisitorRule {
String name = 'SynchronizedOnThis'
int priority = 2
Class astVisitorClass = SynchronizedOnThisAstVisitor
}
class SynchronizedOnThisAstVisitor extends AbstractAstVisitor {
void visitSynchronizedStatement(SynchronizedStatement statement) {
if (isFirstVisit(statement)) {
if (statement.getExpression() instanceof VariableExpression) {
if (statement.expression?.variable == 'this') {
addViolation(statement, "The synchronized statement uses the 'this' reference")
}
}
}
super.visitSynchronizedStatement(statement)
}
}
././@LongLink 0000644 0000000 0000000 00000000147 00000000000 011605 L ustar root root CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/ThisReferenceEscapesConstructorRule.groovy CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/ThisReferenceEscapesConstructorRule.groo0000644 0001750 0001750 00000006556 12137611550 033407 0 ustar ebourg ebourg /*
* Copyright 2013 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.concurrency
import org.codehaus.groovy.ast.ConstructorNode
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.NamedArgumentListExpression
import org.codehaus.groovy.ast.expr.TupleExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
/**
* Reports constructors passing the 'this' reference to other methods.
* This equals exposing a half-baked objects and can lead to race conditions during initialization.
* For reference, see
* Java Concurrency Gotchas by Alex Miller and
* Java theory and practice: Safe construction techniques by Brian Goetz.
*
* @author Artur Gajowy
*/
class ThisReferenceEscapesConstructorRule extends AbstractAstVisitorRule {
String name = 'ThisReferenceEscapesConstructor'
int priority = 2
Class astVisitorClass = ThisReferenceEscapesConstructorAstVisitor
}
class ThisReferenceEscapesConstructorAstVisitor extends AbstractAstVisitor {
private boolean withinConstructor = false
@Override
void visitConstructor(ConstructorNode node) {
withinConstructor = true
super.visitConstructor(node)
withinConstructor = false
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
findViolations(call)
super.visitMethodCallExpression(call)
}
@Override
void visitConstructorCallExpression(ConstructorCallExpression call) {
findViolations(call)
}
private void findViolations(Expression methodOrConstructorCall) {
if (withinConstructor && argumentsContainThis(methodOrConstructorCall.arguments)) {
addViolation(methodOrConstructorCall, 'The `this` reference escapes constructor. ' +
'This equals exposing a half-baked object and can lead to race conditions.')
}
}
private boolean argumentsContainThis(TupleExpression argumentsTuple) {
argumentsTuple.expressions.any {
isThisExpression(it) || isNamedArgumentsListContainingThis(it)
}
}
private boolean isThisExpression(Expression expression) {
expression instanceof VariableExpression && expression.isThisExpression()
}
private boolean isNamedArgumentsListContainingThis(Expression expression) {
expression instanceof NamedArgumentListExpression &&
expression.mapEntryExpressions*.valueExpression.any { isThisExpression(it) }
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/SynchronizedMethodRule.groovy 0000644 0001750 0001750 00000003277 12041061500 031267 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import java.lang.reflect.Modifier
/**
* Synchronized Method Rule - This rule reports uses of the synchronized keyword on
* methods. Synchronized methods are the same as synchronizing on 'this', which
* effectively make your synchronization policy public and modifiable by other objects.
* To avoid possibilities of deadlock, it is better to synchronize on internal objects.
*
* @author Hamlet D'Arcy
*/
class SynchronizedMethodRule extends AbstractAstVisitorRule {
String name = 'SynchronizedMethod'
int priority = 2
Class astVisitorClass = SynchronizedMethodAstVisitor
}
class SynchronizedMethodAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
if (Modifier.isSynchronized(node.getModifiers())) {
addViolation(node, "The method $node.name is synchronized at the method level")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/WaitOutsideOfWhileLoopRule.groovy 0000644 0001750 0001750 00000004030 12006632014 032011 0 ustar ebourg ebourg /*
* Copyright 2011 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.concurrency
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.stmt.WhileStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Checks for calls to wait() that are not within a while loop.
*
* See Joshua Bloch's Effective Java: chapter 50 (1st edition) is entitled "Never invoke wait outside a loop."
* See https://www.securecoding.cert.org/confluence/display/java/THI03-J.+Always+invoke+wait()+and+await()+methods+inside+a+loop
*
* @author Chris Mair
*/
class WaitOutsideOfWhileLoopRule extends AbstractAstVisitorRule {
String name = 'WaitOutsideOfWhileLoop'
int priority = 2
Class astVisitorClass = WaitOutsideOfWhileLoopAstVisitor
}
class WaitOutsideOfWhileLoopAstVisitor extends AbstractAstVisitor {
private boolean withinWhileLoop = false
void visitWhileLoop(WhileStatement whileStatement) {
withinWhileLoop = true
super.visitWhileLoop(whileStatement)
withinWhileLoop = false
}
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodNamed(call, 'wait', 0) && !withinWhileLoop) {
addViolation call, 'Only call the wait() method within a while loop. Or better yet, prefer the Java concurrency utilities to wait() and notify()'
}
super.visitMethodCallExpression(call)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/ThreadGroupRule.groovy 0000644 0001750 0001750 00000004003 12311370173 027670 0 ustar ebourg ebourg /*
* Copyright 2011 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.concurrency
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Avoid using ThreadGroup; although it is intended to be used in a threaded environment it contains methods that are not thread safe.
*
* @author 'Hamlet D'Arcy'
*/
class ThreadGroupRule extends AbstractAstVisitorRule {
String name = 'ThreadGroup'
int priority = 2
Class astVisitorClass = ThreadGroupAstVisitor
}
class ThreadGroupAstVisitor extends AbstractAstVisitor {
@Override
void visitConstructorCallExpression(ConstructorCallExpression call) {
if (isConstructorNamed(call, ThreadGroup)) {
addViolation(call, 'Avoid using java.lang.ThreadGroup; it is unsafe')
}
super.visitConstructorCallExpression(call)
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodNamed(call, 'getThreadGroup', 0)) {
addViolation(call, 'Avoid using java.lang.ThreadGroup; it is unsafe')
}
super.visitMethodCallExpression(call)
}
private static boolean isConstructorNamed(ConstructorCallExpression call, Class clazz) {
call.type.name == clazz.name || call.type.name == clazz.simpleName
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/DoubleCheckedLockingRule.groovy 0000644 0001750 0001750 00000007702 12311370173 031445 0 ustar ebourg ebourg /*
* Copyright 2011 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.concurrency
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.expr.BooleanExpression
import org.codehaus.groovy.ast.expr.NotExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codehaus.groovy.ast.stmt.SynchronizedStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* This rule detects double checked locking, where a 'lock hint' is tested for null before initializing an object within a synchronized block. Double checked locking does not guarantee correctness and is an anti-pattern.
*
* @author Hamlet D'Arcy
*/
class DoubleCheckedLockingRule extends AbstractAstVisitorRule {
String name = 'DoubleCheckedLocking'
int priority = 2
Class astVisitorClass = DoubleCheckedLockingAstVisitor
}
class DoubleCheckedLockingAstVisitor extends AbstractAstVisitor {
@Override
void visitIfElse(IfStatement node) {
addViolationOnDoubleLocking(node)
super.visitIfElse(node)
}
private addViolationOnDoubleLocking(IfStatement node) {
if (!AstUtil.expressionIsNullCheck(node)) {
return
}
SynchronizedStatement syncStatement = getSynchronizedStatement(node.ifBlock)
if (!syncStatement) {
return
}
if (!AstUtil.isOneLiner(syncStatement.code)) {
return
}
def synchContents = syncStatement.code.statements[0]
if (AstUtil.expressionIsNullCheck(synchContents)) {
def varName1 = getNullCheckVariableName(node.booleanExpression)
def varName2 = getNullCheckVariableName(synchContents.booleanExpression)
if (varName1 == varName2) {
if (AstUtil.isOneLiner(synchContents.ifBlock) && AstUtil.expressionIsAssignment(synchContents.ifBlock.statements[0], varName2)) {
addViolation(synchContents.ifBlock.statements[0], "Double checked locking detected for variable ${varName1}. replace with more robust lazy initialization")
}
}
}
}
private static SynchronizedStatement getSynchronizedStatement(ASTNode statement) {
if (statement instanceof BlockStatement && statement.statements?.size() == 1) {
if (statement.statements[0] instanceof SynchronizedStatement) {
return statement.statements[0]
}
}
null
}
private static String getNullCheckVariableName(ASTNode node) {
if (!(node instanceof BooleanExpression)) {
return null
}
if (AstUtil.isBinaryExpressionType(node.expression, '==')) {
if (AstUtil.isNull(node.expression.leftExpression) && node.expression.rightExpression instanceof VariableExpression) {
return node.expression.rightExpression.variable
} else if (AstUtil.isNull(node.expression.rightExpression) && node.expression.leftExpression instanceof VariableExpression) {
return node.expression.leftExpression.variable
}
} else if (node.expression instanceof NotExpression && node.expression.expression instanceof VariableExpression) {
return node.expression.expression.variable
}
null
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/concurrency/SynchronizedOnBoxedPrimitiveRule.groovy 0000644 0001750 0001750 00000004020 12006632014 033266 0 ustar ebourg ebourg /*
* 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.concurrency
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.SynchronizedStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* The code synchronizes on a boxed primitive constant, such as an Integer. Since Integer objects can be cached and
* shared, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness and
* possible deadlock
*
* @author 'Hamlet D'Arcy'
*/
class SynchronizedOnBoxedPrimitiveRule extends AbstractAstVisitorRule {
String name = 'SynchronizedOnBoxedPrimitive'
int priority = 2
Class astVisitorClass = SynchronizedOnBoxedPrimitiveAstVisitor
}
class SynchronizedOnBoxedPrimitiveAstVisitor extends AbstractAstVisitor {
@Override
void visitSynchronizedStatement(SynchronizedStatement statement) {
if (statement.expression instanceof VariableExpression) {
Class type = AstUtil.getFieldType(currentClassNode, statement.expression.variable)
if (type in [Byte, Short, Double, Integer, Long, Float, Character, Boolean]) {
addViolation(statement, "Synchronizing on the $type.simpleName field $statement.expression.variable is unsafe. Do not synchronize on boxed types")
}
}
super.visitSynchronizedStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/FieldReferenceAstVisitor.groovy 0000644 0001750 0001750 00000010777 12465006222 027174 0 ustar ebourg ebourg /*
* Copyright 2012 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
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.PropertyNode
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.util.AstUtil
/**
* AST Visitor that searches for references to the fields specified on the constructor
*
* @author Chris Mair
*/
class FieldReferenceAstVisitor extends AbstractAstVisitor {
private final Map unreferencedFieldMap = [:]
FieldReferenceAstVisitor(Collection fields) {
fields.each { fieldNode ->
// Cannot use map syntax here because the name might be a property on Map, such as "metaClass"
unreferencedFieldMap.put(fieldNode.name, fieldNode)
}
}
Collection getUnreferencedFields() {
return unreferencedFieldMap.values()
}
void visitVariableExpression(VariableExpression expression) {
unreferencedFieldMap.remove(expression.name)
super.visitVariableExpression(expression)
}
void visitProperty(PropertyNode node) {
unreferencedFieldMap.remove(node.name)
super.visitProperty(node)
}
void visitPropertyExpression(PropertyExpression expression) {
if (expression.objectExpression instanceof VariableExpression &&
expression.objectExpression.name in ['this', currentClassNode.nameWithoutPackage] &&
expression.property instanceof ConstantExpression) {
unreferencedFieldMap.remove(expression.property.value)
} else if (expression.objectExpression instanceof PropertyExpression &&
expression.objectExpression.objectExpression instanceof VariableExpression &&
expression.objectExpression.property instanceof ConstantExpression &&
expression.objectExpression.objectExpression.name == currentClassNode.outerClass?.name &&
expression.objectExpression.property.value == 'this' ) {
unreferencedFieldMap.remove(expression.property.value)
}
super.visitPropertyExpression(expression)
}
void visitMethodEx(MethodNode node) {
if (node.parameters) {
node.parameters.each { parameter ->
def initialExpression = parameter.initialExpression
if (initialExpression && AstUtil.respondsTo(initialExpression, 'getName')) {
unreferencedFieldMap.remove(initialExpression.name)
}
}
}
super.visitMethodEx(node)
}
void visitMethodCallExpression(MethodCallExpression call) {
// If there happens to be a method call on a method with the same name as the field.
// This handles the case of defining a closure and then executing it, e.g.:
// private myClosure = { println 'ok' }
// ...
// myClosure()
// But this could potentially "hide" some unused fields (i.e. false negatives).
if (AstUtil.isMethodCallOnObject(call, 'this') && call.method instanceof ConstantExpression) {
unreferencedFieldMap.remove(call.method.value)
} else if (call.objectExpression instanceof PropertyExpression &&
call.objectExpression.objectExpression instanceof VariableExpression &&
call.objectExpression.property instanceof ConstantExpression &&
call.method instanceof ConstantExpression &&
call.objectExpression.objectExpression.name == currentClassNode.outerClass?.name &&
call.objectExpression.property.value == 'this') {
unreferencedFieldMap.remove(call.method.value)
}
super.visitMethodCallExpression(call)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/ 0000755 0001750 0001750 00000000000 12623571301 022323 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/UnusedPrivateMethodParameterRule.groovy 0000644 0001750 0001750 00000004515 12051045102 032215 0 ustar ebourg ebourg /*
* Copyright 2011 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.unused
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.InnerClassNode
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import java.lang.reflect.Modifier
/**
* Rule that checks for parameters to private methods that are not referenced within the method body.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class UnusedPrivateMethodParameterRule extends AbstractAstVisitorRule {
String name = 'UnusedPrivateMethodParameter'
int priority = 2
String ignoreRegex = 'ignore|ignored'
Class astVisitorClass = UnusedPrivateMethodParameterAstVisitor
}
class UnusedPrivateMethodParameterAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
if (Modifier.isPrivate(node.modifiers)) {
def unusedParameterNames = node.parameters*.name
def collector = new ReferenceCollector()
collector.visitMethod(node)
getAnonymousClasses().each { ClassNode it ->
it.visitContents(collector)
}
unusedParameterNames.removeAll(collector.references)
unusedParameterNames.removeAll { it =~ rule.ignoreRegex }
unusedParameterNames.each { parameterName ->
addViolation(node, "Method parameter [$parameterName] is never referenced in the method $node.name of class $currentClassName")
}
}
}
private List getAnonymousClasses() {
sourceCode.ast.classes.findAll {
it instanceof InnerClassNode && it.anonymous
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/UnusedVariableRule.groovy 0000644 0001750 0001750 00000013223 12465005702 027335 0 ustar ebourg ebourg /*
* 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.unused
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.InnerClassNode
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.DeclarationExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.source.SourceCode
import org.codenarc.util.AstUtil
import org.codenarc.util.WildcardPattern
import org.codehaus.groovy.ast.stmt.ForStatement
/**
* Rule that checks for variables that are not referenced.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class UnusedVariableRule extends AbstractAstVisitorRule {
String name = 'UnusedVariable'
int priority = 2
String ignoreVariableNames
@Override
void applyTo(SourceCode sourceCode, List violations) {
// If AST is null, skip this source code
def ast = sourceCode.ast
if (ast && ast.classes) {
def anonymousClasses = getAnonymousClasses(ast.classes)
def collector = new ReferenceCollector()
anonymousClasses.each {
collector.visitClass(it)
}
def anonymousReferences = collector.references
ast.classes.each { classNode ->
if (shouldApplyThisRuleTo(classNode)) {
def visitor = new UnusedVariableAstVisitor(anonymousReferences: anonymousReferences)
visitor.rule = this
visitor.sourceCode = sourceCode
visitor.visitClass(classNode)
violations.addAll(visitor.violations)
}
}
}
}
private static List getAnonymousClasses(List classes) {
classes.findAll {
it instanceof InnerClassNode && it.anonymous
}
}
}
class UnusedVariableAstVisitor extends AbstractAstVisitor {
private final variablesByBlockScope = [] as Stack
private variablesInCurrentBlockScope
private anonymousReferences
void visitDeclarationExpression(DeclarationExpression declarationExpression) {
if (isFirstVisit(declarationExpression)) {
def varExpressions = AstUtil.getVariableExpressions(declarationExpression)
varExpressions.each { varExpression ->
variablesInCurrentBlockScope[varExpression] = false
}
}
super.visitDeclarationExpression(declarationExpression)
}
void visitBlockStatement(BlockStatement block) {
beforeBlock()
super.visitBlockStatement(block)
afterBlock()
}
@Override
void visitForLoop(ForStatement forLoop) {
beforeBlock()
super.visitForLoop(forLoop)
afterBlock()
}
private beforeBlock() {
variablesInCurrentBlockScope = [:]
variablesByBlockScope.push(variablesInCurrentBlockScope)
}
private afterBlock() {
variablesInCurrentBlockScope.each { varExpression, isUsed ->
if (!isIgnoredVariable(varExpression) && !isUsed && !anonymousReferences.contains(varExpression.name)) {
addViolation(varExpression, "The variable [${varExpression.name}] in class $currentClassName is not used")
}
}
variablesByBlockScope.pop()
variablesInCurrentBlockScope = variablesByBlockScope.empty() ? null : variablesByBlockScope.peek()
}
void visitVariableExpression(VariableExpression expression) {
markVariableAsReferenced(expression.name, expression)
super.visitVariableExpression(expression)
}
void visitMethodCallExpression(MethodCallExpression call) {
// If there happens to be a method call on a method with the same name as the variable.
// This handles the case of defining a closure and then executing it, e.g.:
// def myClosure = { println 'ok' }
// myClosure()
// But this could potentially "hide" some unused variables (i.e. false negatives).
if (call.isImplicitThis() &&
call.method instanceof ConstantExpression) {
markVariableAsReferenced(call.method.value, null)
}
super.visitMethodCallExpression(call)
}
@SuppressWarnings('NestedForLoop')
private void markVariableAsReferenced(String varName, VariableExpression varExpression) {
for(blockVariables in variablesByBlockScope) {
for(var in blockVariables.keySet()) {
if (var.name == varName && var != varExpression) {
blockVariables[var] = true
return
}
}
}
}
private boolean isIgnoredVariable(VariableExpression expression) {
new WildcardPattern(rule.ignoreVariableNames, false).matches(expression.name)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/UnusedObjectRule.groovy 0000644 0001750 0001750 00000003602 12006632014 027007 0 ustar ebourg ebourg /*
* 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.unused
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Checks for object constructions that are not assigned or used (i.e., ignored).
* Ignores unassigned objects if the construction is the last statement within a block,
* because it may be the intentional return value.
*
* By default, this rule does not apply to test files.
*
* @author Chris Mair
*/
class UnusedObjectRule extends AbstractAstVisitorRule {
String name = 'UnusedObject'
int priority = 2
Class astVisitorClass = UnusedObjectAstVisitor
String doNotApplyToFilesMatching = DEFAULT_TEST_FILES
}
class UnusedObjectAstVisitor extends AbstractLastStatementInBlockAstVisitor {
void visitExpressionStatement(ExpressionStatement statement) {
if (isFirstVisit(statement) &&
statement.expression instanceof ConstructorCallExpression &&
!statement.expression.isSuperCall() &&
!statement.expression.isThisCall() &&
!isLastStatementInBlock(statement)) {
addViolation(statement, 'The instantiated object is not used')
}
super.visitExpressionStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/UnusedPrivateFieldRule.groovy 0000644 0001750 0001750 00000005564 12006632014 030170 0 ustar ebourg ebourg /*
* 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.unused
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractSharedAstVisitorRule
import org.codenarc.rule.AstVisitor
import org.codenarc.rule.FieldReferenceAstVisitor
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
import org.codenarc.util.WildcardPattern
/**
* Rule that checks for private fields that are not referenced within the same class.
*
* The ignoreFieldNames property optionally specifies one or more
* (comma-separated) field names that should be ignored (i.e., that should not cause a
* rule violation). The name(s) may optionally include wildcard characters ('*' or '?').
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class UnusedPrivateFieldRule extends AbstractSharedAstVisitorRule {
String name = 'UnusedPrivateField'
int priority = 2
String ignoreFieldNames = 'serialVersionUID'
@Override
protected AstVisitor getAstVisitor(SourceCode sourceCode) {
def allPrivateFields = collectAllPrivateFields(sourceCode.ast)
return new FieldReferenceAstVisitor(allPrivateFields)
}
@Override
protected List getViolations(AstVisitor visitor, SourceCode sourceCode) {
visitor.unreferencedFields.each { FieldNode fieldNode ->
visitor.addViolation(fieldNode, "The field ${fieldNode.name} is not used within the class ${fieldNode.owner?.name}")
}
return visitor.violations
}
@SuppressWarnings('NestedBlockDepth')
private collectAllPrivateFields(ast) {
def allPrivateFields = []
ast.classes.each { classNode ->
if (shouldApplyThisRuleTo(classNode)) {
classNode.fields.inject(allPrivateFields) { acc, fieldNode ->
def wildcardPattern = new WildcardPattern(ignoreFieldNames, false)
def isPrivate = fieldNode.modifiers & FieldNode.ACC_PRIVATE
def isNotGenerated = fieldNode.lineNumber != -1
def isIgnored = wildcardPattern.matches(fieldNode.name)
if (isPrivate && isNotGenerated && !isIgnored) {
acc << fieldNode
}
acc
}
}
}
allPrivateFields
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/AbstractLastStatementInBlockAstVisitor.groovy0000644 0001750 0001750 00000002602 12006632014 033332 0 ustar ebourg ebourg /*
* 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.unused
import org.codehaus.groovy.ast.stmt.BlockStatement
import org.codehaus.groovy.ast.stmt.Statement
import org.codenarc.rule.AbstractAstVisitor
/**
* Abstract superclass for AstVisitor classes that need to determine whether a Statement is
* the last statement within a block.
*
* @author Chris Mair
*/
abstract class AbstractLastStatementInBlockAstVisitor extends AbstractAstVisitor {
private final lastStatements = [] as Set
protected boolean isLastStatementInBlock(Statement statement) {
lastStatements.contains(statement)
}
void visitBlockStatement(BlockStatement block) {
if (block.statements) {
lastStatements << block.statements.last()
}
super.visitBlockStatement(block)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/UnusedPrivateMethodRule.groovy 0000644 0001750 0001750 00000015406 12311373553 030372 0 ustar ebourg ebourg /*
* 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.unused
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractSharedAstVisitorRule
import org.codenarc.rule.AstVisitor
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
import org.codehaus.groovy.ast.expr.*
/**
* Rule that checks for private methods that are not referenced within the same class.
*
* Known limitations:
*
*
Does not handle method reference through property access: getName() accessed as x.name
*
Does not handle method invocations when method name is a GString (e.g. this."${methodName}"
*
Does not handle invoking private method of another instance (i.e. other than 'this')
*
Does not differentiate between multiple private methods with the same name but different parameters (i.e., overloaded)
*
Does not check constructors
*
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class UnusedPrivateMethodRule extends AbstractSharedAstVisitorRule {
String name = 'UnusedPrivateMethod'
int priority = 2
@Override
protected AstVisitor getAstVisitor(SourceCode sourceCode) {
def allPrivateMethods = collectAllPrivateMethods(sourceCode.ast)
return new UnusedPrivateMethodAstVisitor(allPrivateMethods, sourceCode.ast.classes*.name)
}
@Override
protected List getViolations(AstVisitor visitor, SourceCode sourceCode) {
visitor.unusedPrivateMethods.each { key, value ->
visitor.addViolation(value, "The method $key is not used within ${sourceCode.name ?: 'the class'}")
}
return visitor.violations
}
@SuppressWarnings('NestedBlockDepth')
private collectAllPrivateMethods(ast) {
def allPrivateMethods = [:]
ast.classes.each { classNode ->
if (shouldApplyThisRuleTo(classNode)) {
classNode.methods.inject(allPrivateMethods) { acc, methodNode ->
if ((Modifier.isPrivate(methodNode.modifiers)) && !allPrivateMethods.containsKey(methodNode.name)) {
allPrivateMethods.put(methodNode.name, methodNode)
}
}
}
}
allPrivateMethods
}
}
@SuppressWarnings('DuplicateLiteral')
class UnusedPrivateMethodAstVisitor extends AbstractAstVisitor {
private final Map unusedPrivateMethods
private final List classNames
UnusedPrivateMethodAstVisitor(Map unusedPrivateMethods, List classNames) {
this.classNames = classNames.inject(['this']) { acc, value ->
acc.add value
if (value.contains('$') && !value.endsWith('$')) {
acc.add value[value.lastIndexOf('$') + 1..-1]
} else if (value.contains('.') && !value.endsWith('.')) {
acc.add value[value.lastIndexOf('.') + 1..-1]
}
acc
}
this.unusedPrivateMethods = unusedPrivateMethods
}
void visitMethodCallExpression(MethodCallExpression expression) {
classNames.each {
if (isMethodCall(expression, it)) {
unusedPrivateMethods.remove(expression.method.value)
}
}
// Static invocation through current class name
if (isMethodCall(expression, currentClassNode.nameWithoutPackage)) {
unusedPrivateMethods.remove(expression.method.value)
}
super.visitMethodCallExpression(expression)
}
void visitMethodPointerExpression(MethodPointerExpression methodPointerExpression) {
if (methodPointerExpression.expression instanceof VariableExpression &&
classNames.contains(methodPointerExpression.expression.name) &&
methodPointerExpression.methodName instanceof ConstantExpression) {
unusedPrivateMethods.remove(methodPointerExpression.methodName.value)
}
super.visitMethodPointerExpression(methodPointerExpression)
}
@Override
void visitVariableExpression(VariableExpression expression) {
if (expression.name.size() == 1) {
unusedPrivateMethods.remove('get' + expression.name.toUpperCase())
unusedPrivateMethods.remove('is' + expression.name.toUpperCase())
unusedPrivateMethods.remove('set' + expression.name.toUpperCase())
} else {
unusedPrivateMethods.remove('get' + expression.name[0].toUpperCase() + expression.name[1..-1])
unusedPrivateMethods.remove('is' + expression.name[0].toUpperCase() + expression.name[1..-1])
unusedPrivateMethods.remove('set' + expression.name[0].toUpperCase() + expression.name[1..-1])
}
super.visitVariableExpression expression
}
@Override
void visitPropertyExpression(PropertyExpression expression) {
if (isConstantString(expression.property)) {
def propertyName = expression.property.value
if (propertyName.size() == 1) {
def propertyNameUpperCase = expression.property.value.toUpperCase()
unusedPrivateMethods.remove('get' + propertyNameUpperCase)
unusedPrivateMethods.remove('set' + propertyNameUpperCase)
} else {
if (propertyName) {
unusedPrivateMethods.remove('get' + propertyName[0].toUpperCase() + propertyName[1..-1])
unusedPrivateMethods.remove('set' + propertyName[0].toUpperCase() + propertyName[1..-1])
}
}
}
super.visitPropertyExpression expression
}
private static boolean isConstantString(Expression expression) {
expression instanceof ConstantExpression && expression.value instanceof String
}
private static boolean isMethodCall(MethodCallExpression expression, String targetName) {
AstUtil.isMethodCallOnObject(expression, targetName) &&
expression.method instanceof ConstantExpression
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/UnusedArrayRule.groovy 0000644 0001750 0001750 00000003133 12006632016 026660 0 ustar ebourg ebourg /*
* 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.unused
import org.codehaus.groovy.ast.expr.ArrayExpression
import org.codehaus.groovy.ast.stmt.ExpressionStatement
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Checks for array allocations that are not assigned or used (i.e., it is ignored).
* Ignores unassigned arrays if the construction is the last statement within a block,
* because it may be the intentional return value.
*
* @author Chris Mair
*/
class UnusedArrayRule extends AbstractAstVisitorRule {
String name = 'UnusedArray'
int priority = 2
Class astVisitorClass = UnusedArrayAstVisitor
}
class UnusedArrayAstVisitor extends AbstractLastStatementInBlockAstVisitor {
void visitExpressionStatement(ExpressionStatement statement) {
if (statement.expression instanceof ArrayExpression && !isLastStatementInBlock(statement)) {
addViolation(statement, 'The result of the array expression is ignored')
}
super.visitExpressionStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/UnusedMethodParameterRule.groovy 0000644 0001750 0001750 00000005774 12051271130 030674 0 ustar ebourg ebourg /*
* Copyright 2011 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.unused
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.InnerClassNode
import org.codehaus.groovy.ast.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* This rule finds instances of method parameters not being used. It does not analyze private methods (that is done by the UnusedPrivateMethodParameter rule) or methods marked @Override.
*
* @author Hamlet D'Arcy
* @author Chris Mair
*/
class UnusedMethodParameterRule extends AbstractAstVisitorRule {
String name = 'UnusedMethodParameter'
int priority = 2
String ignoreRegex = 'ignore|ignored'
String ignoreClassRegex = '.*Category'
Class astVisitorClass = UnusedMethodParameterAstVisitor
}
class UnusedMethodParameterAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
if (!currentClassNode.isInterface() && !node.isAbstract() && !(currentClassName ==~ rule.ignoreClassRegex)
&& !Modifier.isPrivate(node.modifiers) && AstUtil.getAnnotation(node, 'Override') == null
&& !isMainMethod(node)) {
def unusedParameterNames = node.parameters*.name
def collector = new ReferenceCollector()
collector.visitMethod(node)
getAnonymousClasses().each { ClassNode it ->
it.visitContents(collector)
}
unusedParameterNames.removeAll(collector.references)
unusedParameterNames.removeAll { it =~ rule.ignoreRegex }
unusedParameterNames.each { parameterName ->
addViolation(node, "Method parameter [$parameterName] is never referenced in the method $node.name of class $currentClassName")
}
}
}
private static boolean isMainMethod(MethodNode node) {
AstUtil.isMethodNode(node, 'main', 1) &&
(node.parameters[0].dynamicTyped || node.parameters[0].type.name in ['String[]', '[Ljava.lang.String;']) &&
(node.isVoidMethod() || node.dynamicReturnType) &&
node.isStatic()
}
private List getAnonymousClasses() {
sourceCode.ast.classes.findAll {
it instanceof InnerClassNode && it.anonymous
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/unused/ReferenceCollector.groovy 0000644 0001750 0001750 00000003524 12465654155 027360 0 ustar ebourg ebourg /*
* Copyright 2011 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.unused
import org.codehaus.groovy.ast.ClassCodeVisitorSupport
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.control.SourceUnit
import org.codenarc.util.AstUtil
/**
*
* @author Hamlet D'Arcy
*/
class ReferenceCollector extends ClassCodeVisitorSupport {
def references = [] as Set
void visitVariableExpression(VariableExpression expression) {
references.add(expression.name)
}
void visitMethodCallExpression(MethodCallExpression call) {
// Check for method call on a method with the same name as the parameter.
// This handles the case of a parameter being a closure that is then invoked within the method, e.g.:
// private myMethod1(Closure closure) {
// println closure()
// }
if (AstUtil.isMethodCallOnObject(call, 'this') && call.method instanceof ConstantExpression) {
references.add(call.method.value)
}
super.visitMethodCallExpression(call)
}
@Override
SourceUnit getSourceUnit() {
throw new UnsupportedOperationException()
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/dry/ 0000755 0001750 0001750 00000000000 12623571301 021616 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/dry/DryUtil.groovy 0000644 0001750 0001750 00000013573 12014546114 024470 0 ustar ebourg ebourg /*
* Copyright 2011 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.dry
import org.codehaus.groovy.ast.expr.*
/**
* Utility methods for the DRY rule classes
*
* @author Chris Mair
*/
class DryUtil {
/**
* @return true only if both MapExpressions have the same set of constant or literal keys and values, in the same order.
*/
static boolean areTheSameConstantOrLiteralMaps(MapExpression mapExpression1, MapExpression mapExpression2) {
def mapEntryExpressions1 = mapExpression1.mapEntryExpressions
def mapEntryExpressions2 = mapExpression2.mapEntryExpressions
if (mapEntryExpressions1.size() == mapEntryExpressions2.size()) {
for (int index = 0; index < mapEntryExpressions1.size(); index++) { // may be empty
if (!areTheSameConstantOrLiteralMapEntryExpression(mapEntryExpressions1[index], mapEntryExpressions2[index])) {
return false
}
}
return true // all entries matched
}
return false
}
/**
* @return true only if both MapEntryExpressions have the same constant or literal key and value
*/
static boolean areTheSameConstantOrLiteralMapEntryExpression(MapEntryExpression mapEntryExpression1, MapEntryExpression mapEntryExpression2) {
if (mapEntryExpression1 == null || mapEntryExpression2 == null) {
return mapEntryExpression1 == mapEntryExpression2
}
return haveTheSameConstantOrLiteralValue(mapEntryExpression1.keyExpression, mapEntryExpression2.keyExpression) &&
haveTheSameConstantOrLiteralValue(mapEntryExpression1.valueExpression, mapEntryExpression2.valueExpression)
}
/**
* @return true only if both Expressions have the same constant or literal value
*/
static boolean haveTheSameConstantOrLiteralValue(Expression expression1, Expression expression2) {
if (expression1.class != expression2.class) {
return false
}
boolean isTheSameValue =
haveTheSameConstantValue(expression1, expression2) ||
haveTheSameConstantPropertyExpression(expression1, expression2) ||
haveTheSameMapLiteralValue(expression1, expression2) ||
haveTheSameListLiteralValue(expression1, expression2)
return isTheSameValue
}
/**
* @return true only if both Expressions are MapExpressions and both have the same set of constant or
* literal keys and values, in the same order.
*/
static boolean haveTheSameMapLiteralValue(Expression expression1, Expression expression2) {
if (!(expression1 instanceof MapExpression && expression2 instanceof MapExpression)) {
return false
}
return areTheSameConstantOrLiteralMaps(expression1, expression2)
}
/**
* @return true only if both Expressions are ListExpressions and both have the same set of constant or literal values, in the same order.
*/
static boolean haveTheSameListLiteralValue(Expression expression1, Expression expression2) {
if (!(expression1 instanceof ListExpression && expression2 instanceof ListExpression)) {
return false
}
return areTheSameConstantOrLiteralLists(expression1, expression2)
}
/**
* @return true only if both ListExpressions have the same set of constant or literal values, in the same order.
*/
static boolean areTheSameConstantOrLiteralLists(ListExpression listExpression1, ListExpression listExpression2) {
def expressions1 = listExpression1.expressions
def expressions2 = listExpression2.expressions
if (expressions1.size() == expressions2.size()) {
for (int index = 0; index < expressions1.size(); index++) { // may be empty
if (!haveTheSameConstantOrLiteralValue(expressions1[index], expressions2[index])) {
return false
}
}
return true // all entries matched
}
return false
}
/**
* @return true only if both Expressions have the same constant or literal values
*/
static boolean haveTheSameConstantValue(Expression expression1, Expression expression2) {
if (!(expression1 instanceof ConstantExpression && expression2 instanceof ConstantExpression)) {
return false
}
return expression1.value == expression2.value
}
/**
* @return true only if both Expressions have the same constant property expression (e.g., Object.Property)
*/
static boolean haveTheSameConstantPropertyExpression(Expression expression1, Expression expression2) {
if (!(expression1 instanceof PropertyExpression && expression2 instanceof PropertyExpression)) {
return false
}
Expression object1 = ((PropertyExpression) expression1).getObjectExpression()
Expression property1 = ((PropertyExpression) expression1).getProperty()
Expression object2 = ((PropertyExpression) expression2).getObjectExpression()
Expression property2 = ((PropertyExpression) expression2).getProperty()
boolean isTheSame = false
if (object1 instanceof VariableExpression) {
isTheSame = object1.getName() == object2.getName() &&
property1.getText() == property2.getText()
}
return isTheSame
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/dry/DuplicateMapLiteral.groovy 0000644 0001750 0001750 00000004040 12311373552 026752 0 ustar ebourg ebourg /*
* Copyright 2011 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.dry
import org.codehaus.groovy.ast.expr.MapExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Check for multiple instances of the same Map literal, limited to Maps where the keys
* and values are all constants or literals.
*
* @author Chris Mair
*/
class DuplicateMapLiteralRule extends AbstractAstVisitorRule {
String name = 'DuplicateMapLiteral'
int priority = 3
String doNotApplyToFilesMatching = DEFAULT_TEST_FILES
Class astVisitorClass = DuplicateMapLiteralAstVisitor
}
class DuplicateMapLiteralAstVisitor extends AbstractAstVisitor {
private final Collection
* To find the package-relevant sub-path in the file path the groupId needs to be configured.
* It is expected to appear in every package declaration.
*
* @author Simon Tost
*/
class PackageNameMatchesFilePathRule extends AbstractRule {
String groupId
String name = 'PackageNameMatchesFilePath'
int priority = 2
@Override
boolean isReady() {
return groupId
}
@Override
void applyTo(SourceCode sourceCode, List violations) {
PackageNode packageNode = sourceCode.ast?.package
if (!packageNode || !sourceCode.path) {
return
}
def normalizedPath = PathUtil.normalizePath(sourceCode.path - sourceCode.name)
def dotSeparatedFolders = normalizedPath.replace('/', '.')
dotSeparatedFolders = removeTrailingPeriod(dotSeparatedFolders)
def packageName = removeTrailingPeriod(packageNode.name)
if (!dotSeparatedFolders.find(groupId) || !packageName.find(groupId)) {
violations << createViolation(sourceCode, packageNode,
"Could not find groupId '$groupId' in package ($packageName) or file's path ($sourceCode.path)")
} else {
def groupPattern = Pattern.quote(groupId)
def subfolders = dotSeparatedFolders.split(groupPattern, 2)[1]
def subpackages = packageName.split(groupPattern, 2)[1]
if (subfolders != subpackages) {
violations << createViolation(sourceCode, packageNode, mismatchMessage(subfolders))
}
}
}
private String removeTrailingPeriod(String str) {
return (str.endsWith('.')) ? str[0..-2] : str
}
private mismatchMessage(String subfolders) {
def dotSeparatedPath = groupId + subfolders
def subpath = dotSeparatedPath.replace('.', File.separator)
"The package source file's path ($subpath) should match the package declaration"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/naming/FieldNameRule.groovy 0000644 0001750 0001750 00000012575 12403117552 026226 0 ustar ebourg ebourg /*
* 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.naming
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.PropertyNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.WildcardPattern
import java.lang.reflect.Modifier
/**
* Rule that verifies that the name of each field matches a regular expression. By default it checks that
* non-final field names start with a lowercase letter and contains only letters or numbers.
* By default, final field names start with an uppercase letter and contain only uppercase
* letters, numbers and underscores.
*
* NOTE: This rule checks only regular fields of a class, not properties. In Groovy,
* properties are fields declared with no access modifier (public, protected, private). Thus,
* this rule only checks fields that specify an access modifier. For naming of regular
* properties, see PropertyNameRule.
*
* The regex property specifies the default regular expression to validate a field name.
* It is required and cannot be null or empty. It defaults to '[a-z][a-zA-Z0-9]*'.
*
* The finalRegex property specifies the regular expression to validate final
* field names. It is optional and defaults to null, so that final fields that are not
* static will be validated using regex.
*
* The staticRegex property specifies the regular expression to validate static
* field names. It is optional and defaults to null, so that static fields that are
* non-final will be validated using regex.
*
* The staticFinalRegex property specifies the regular expression to validate static final
* field names. It is optional, but defaults to '[A-Z][A-Z0-9_]*'.
*
* The privateStaticFinalRegex property specifies the regular expression to validate private static final
* field names. It is optional, but defaults to '[A-Z][A-Z0-9_]*'.
*
* The order of precedence for the regular expression properties is: privateStaticFinalRegex, staticFinalRegex,
* finalRegex, staticRegex and finally regex. In other words, the first
* regex in that list matching the modifiers for the field is the one that is applied for the field name validation.
*
* The ignoreFieldNames property optionally specifies one or more
* (comma-separated) field names that should be ignored (i.e., that should not cause a
* rule violation). The name(s) may optionally include wildcard characters ('*' or '?').
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class FieldNameRule extends AbstractAstVisitorRule {
String name = 'FieldName'
int priority = 2
String regex = DEFAULT_FIELD_NAME
String staticRegex
String finalRegex
String staticFinalRegex = DEFAULT_CONST_NAME
String privateStaticFinalRegex
String ignoreFieldNames = 'serialVersionUID'
Class astVisitorClass = FieldNameAstVisitor
void validate() {
assert regex
}
}
class FieldNameAstVisitor extends AbstractAstVisitor {
private final Set propertyNames = []
void visitField(FieldNode fieldNode) {
if (!isProperty(fieldNode) && !isIgnoredPropertyName(fieldNode)) {
def mod = fieldNode.modifiers
def re = rule.regex
if (Modifier.isStatic(mod)) {
re = rule.staticRegex ?: re
}
if (Modifier.isFinal(mod)) {
re = rule.finalRegex ?: re
}
if ((Modifier.isFinal(mod)) && (Modifier.isStatic(mod))) {
re = rule.staticFinalRegex ?: re
}
if ((Modifier.isFinal(mod)) && Modifier.isStatic(mod) && Modifier.isPrivate(mod)) {
re = rule.privateStaticFinalRegex ?: re
}
if (!(fieldNode.name ==~ re)) {
addViolation(fieldNode, "The fieldname $fieldNode.name in class ${fieldNode.owner?.name} does not match ${re.toString()}")
}
}
super.visitField(fieldNode)
}
void visitProperty(PropertyNode node) {
propertyNames << node.name
super.visitProperty(node)
}
private boolean isIgnoredPropertyName(FieldNode node) {
new WildcardPattern(rule.ignoreFieldNames, false).matches(node.name)
}
private boolean isProperty(FieldNode node) {
// This assumes that the property node is visited before the (regular) field node
propertyNames.contains(node.name)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/naming/VariableNameRule.groovy 0000644 0001750 0001750 00000006412 12311373552 026723 0 ustar ebourg ebourg /*
* 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.naming
import org.codehaus.groovy.ast.expr.DeclarationExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codenarc.util.WildcardPattern
/**
* Rule that verifies that the name of each variable matches a regular expression. By default it checks that
* non-final variable names start with a lowercase letter and contains only letters or numbers.
* By default, final variable names start with an uppercase letter and contain only uppercase
* letters, numbers and underscores.
*
* The regex property specifies the default regular expression to validate a variable name.
* It is required and cannot be null or empty. It defaults to '[a-z][a-zA-Z0-9]*'.
*
* The finalRegex property specifies the regular expression to validate final
* variable names. It is optional but defaults to '[A-Z][A-Z0-9_]*'. If not set, then regex is
* used to validate final variables.
*
* The ignoreVariableNames property optionally specifies one or more
* (comma-separated) variable names that should be ignored (i.e., that should not cause a
* rule violation). The name(s) may optionally include wildcard characters ('*' or '?').
*
* @author Chris Mair
*/
class VariableNameRule extends AbstractAstVisitorRule {
String name = 'VariableName'
int priority = 2
String regex = DEFAULT_VAR_NAME
String finalRegex = DEFAULT_CONST_NAME
String ignoreVariableNames
Class astVisitorClass = VariableNameAstVisitor
}
class VariableNameAstVisitor extends AbstractAstVisitor {
void visitDeclarationExpression(DeclarationExpression declarationExpression) {
assert rule.regex
if (isFirstVisit(declarationExpression)) {
def varExpressions = AstUtil.getVariableExpressions(declarationExpression)
def re = rule.finalRegex && AstUtil.isFinalVariable(declarationExpression, sourceCode) ?
rule.finalRegex : rule.regex
varExpressions.each { varExpression ->
if (!new WildcardPattern(rule.ignoreVariableNames, false).matches(varExpression.name) &&
!(varExpression.name ==~ re)) {
def msg = "Variable named $varExpression.name in class $currentClassName does not match the pattern ${re.toString()}"
addViolation(declarationExpression, msg)
}
}
}
super.visitDeclarationExpression(declarationExpression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/naming/PropertyNameRule.groovy 0000644 0001750 0001750 00000010572 12311373552 027024 0 ustar ebourg ebourg /*
* 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.naming
import org.codehaus.groovy.ast.PropertyNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.WildcardPattern
import java.lang.reflect.Modifier
/**
* Rule that verifies that the name of each property matches a regular expression. By default it checks that
* property names (other than static final) start with a lowercase letter and contains only letters
* or numbers. By default, static final property names start with an uppercase letter and contain
* only uppercase letters, numbers and underscores.
*
* NOTE: This rule checks only properties of a class, not regular fields. In Groovy,
* properties are fields declared with no access modifier (public, protected, private).
* For naming of regular fields, see FieldNameRule.
*
* The regex property specifies the default regular expression to validate a property name.
* It is required and cannot be null or empty. It defaults to '[a-z][a-zA-Z0-9]*'.
*
* The finalRegex property specifies the regular expression to validate final
* property names. It is optional and defaults to null, so that final properties that are
* non-static will be validated using regex.
*
* The staticRegex property specifies the regular expression to validate static
* property names. It is optional and defaults to null, so that static properties that are
* non-final will be validated using regex.
*
* The staticFinalRegex property specifies the regular expression to validate static final
* property names. It is optional but defaults to '[A-Z][A-Z0-9_]*'.
*
* The order of precedence for the regular expression properties is: staticFinalRegex,
* finalRegex, staticRegex and finally regex. In other words, the first
* regex in that list matching the modifiers for the property is the one that is applied for the property
* name validation.
*
* The ignorePropertyNames property optionally specifies one or more
* (comma-separated) property names that should be ignored (i.e., that should not cause a
* rule violation). The name(s) may optionally include wildcard characters ('*' or '?').
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class PropertyNameRule extends AbstractAstVisitorRule {
String name = 'PropertyName'
int priority = 2
String regex = DEFAULT_FIELD_NAME
String staticRegex
String finalRegex
String staticFinalRegex = DEFAULT_CONST_NAME
String ignorePropertyNames
Class astVisitorClass = PropertyNameAstVisitor
void validate() {
assert regex
}
}
class PropertyNameAstVisitor extends AbstractAstVisitor {
void visitProperty(PropertyNode node) {
if (!new WildcardPattern(rule.ignorePropertyNames, false).matches(node.name)) {
def re = rule.regex
def mod = node.modifiers
if (Modifier.isStatic(mod)) {
re = rule.staticRegex ?: re
}
if (Modifier.isFinal(mod)) {
re = rule.finalRegex ?: re
}
if ((Modifier.isFinal(mod)) && (Modifier.isStatic(mod))) {
re = rule.staticFinalRegex ?: re
}
if (!(node.name ==~ re)) {
addViolation(node, "The property name $node.name in class ${node.field?.owner?.name} does not match the pattern $re")
}
}
super.visitProperty(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/naming/ConfusingMethodNameRule.groovy 0000644 0001750 0001750 00000007347 12277665572 030323 0 ustar ebourg ebourg /*
* 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.naming
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.Parameter
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* This rule traps the condition where two methods or closures differ only by their capitalization.
*
* @author Hamlet D'Arcy
* @author Hubert 'Mr. Haki' Klein Ikkink
*/
class ConfusingMethodNameRule extends AbstractAstVisitorRule {
String name = 'ConfusingMethodName'
int priority = 2
Class astVisitorClass = ConfusingMethodNameAstVisitor
}
class ConfusingMethodNameAstVisitor extends AbstractAstVisitor {
void visitClassEx(ClassNode node) {
node.visitContents(new ScopedConfusingMethodNameAstVisitor(this))
}
}
class ScopedConfusingMethodNameAstVisitor extends AbstractAstVisitor {
def lowercaseMethodNames = [] as Set
def lowercaseMethodNamesWithParameterTypes = [] as Set
def lowercaseClosureNames = [] as Set
def lowercaseFieldNames = [:]
def parent
ScopedConfusingMethodNameAstVisitor(AbstractAstVisitor parent) {
this.parent = parent
this.rule = parent.rule
}
void visitMethodEx(MethodNode node) {
String methodName = node.getName().toLowerCase()
String parameterInfo = getParameterDefinitionAsString(node)
String methodNameWithParameters = node.name.toLowerCase() + parameterInfo
if (lowercaseClosureNames.contains(methodName)) {
parent.addViolation(node, 'Found very confusing method name. ' +
'Conflicts with a similar closure name. ' +
"Found method : $node.name $parameterInfo")
} else if (lowercaseMethodNamesWithParameterTypes.contains(methodNameWithParameters)) {
parent.addViolation(node, "Found very confusing method name: $node.name $parameterInfo")
} else if (lowercaseFieldNames.any { it.key == methodName }) {
parent.addViolation(node, "The method name $node.name is similar to the field name ${lowercaseFieldNames[methodName]}")
}
lowercaseMethodNames.add(methodName)
lowercaseMethodNamesWithParameterTypes.add(methodNameWithParameters)
super.visitMethodEx node
}
void visitField(FieldNode node) {
if (AstUtil.isClosureDeclaration(node)) {
String methodName = node.name.toLowerCase()
if (lowercaseClosureNames.contains(methodName)) {
parent.addViolation(node, "Found very confusing closure name: $node.name")
}
lowercaseClosureNames.add(methodName)
} else {
String fieldName = node.name.toLowerCase()
lowercaseFieldNames[fieldName] = node.name
}
super.visitField(node)
}
void visitClassEx(ClassNode node) {
parent.visitClassEx(node)
}
private static String getParameterDefinitionAsString(MethodNode node) {
Parameter[] parameters = node?.getParameters()
'(' + parameters?.collect { it?.type?.toString() }?.join(', ') + ')'
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/naming/AbstractClassNameRule.groovy 0000644 0001750 0001750 00000003352 12311373552 027727 0 ustar ebourg ebourg /*
* 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.naming
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that verifies that the name of an abstract class matches a regular expression specified in
* the regex property. If that property is null or empty, then this rule is not applied
* (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active.
* This rule ignores interfaces.
*
* @see ClassNameRule
* @see InterfaceNameRule
*
* @author Chris Mair
*/
class AbstractClassNameRule extends AbstractAstVisitorRule {
String name = 'AbstractClassName'
int priority = 2
Class astVisitorClass = AbstractClassNameAstVisitor
String regex
boolean isReady() {
regex
}
}
class AbstractClassNameAstVisitor extends AbstractTypeNameAstVisitor {
protected boolean shouldVisit(ClassNode classNode) {
def isAbstract = classNode.modifiers & classNode.ACC_ABSTRACT
def isInterface = classNode.modifiers & classNode.ACC_INTERFACE
isAbstract && !isInterface
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/naming/ClassNameRule.groovy 0000644 0001750 0001750 00000003455 12311373552 026247 0 ustar ebourg ebourg /*
* 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.naming
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that verifies that the name of a class matches a regular expression. By default it checks that the
* class name starts with an uppercase letter and is followed by zero or more word characters
* (letters, numbers or underscores). Implicit classes (i.e. Groovy scripts) are ignored. This rule applies
* to all classes, including abstract classes and interfaces.
*
* The regex property specifies the regular expression to check the class name against. It is
* required and cannot be null or empty. It defaults to '[A-Z]\w*'.
*
* @see AbstractClassNameRule
* @see InterfaceNameRule
*
* @author Chris Mair
*/
class ClassNameRule extends AbstractAstVisitorRule {
String name = 'ClassName'
int priority = 2
String regex = /([A-Z]\w*\$?)*/
Class astVisitorClass = ClassNameAstVisitor
void validate() {
assert regex
}
}
class ClassNameAstVisitor extends AbstractTypeNameAstVisitor {
@Override
protected boolean shouldVisit(ClassNode classNode) {
true
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/naming/ParameterNameRule.groovy 0000644 0001750 0001750 00000006347 12311373552 027125 0 ustar ebourg ebourg /*
* 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.naming
import org.codehaus.groovy.ast.ConstructorNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.ClosureExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.WildcardPattern
/**
* Rule that verifies that the name of each parameter matches a regular expression. This rule applies
* to method parameters, constructor parameters and closure parameters. By default it checks that
* parameter names start with a lowercase letter and contains only letters or numbers.
*
* The regex property specifies the default regular expression used to validate the
* parameter name. It is required and cannot be null or empty. It defaults to '[a-z][a-zA-Z0-9]*'.
*
* The ignoreParameterNames property optionally specifies one or more
* (comma-separated) parameter names that should be ignored (i.e., that should not cause a
* rule violation). The name(s) may optionally include wildcard characters ('*' or '?').
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class ParameterNameRule extends AbstractAstVisitorRule {
String name = 'ParameterName'
int priority = 2
String regex = DEFAULT_VAR_NAME
String ignoreParameterNames
Class astVisitorClass = ParameterNameAstVisitor
void validate() {
assert regex
}
}
class ParameterNameAstVisitor extends AbstractAstVisitor {
void visitMethodEx(MethodNode methodNode) {
processParameters(methodNode.parameters, methodNode.name)
super.visitMethodEx(methodNode)
}
@Override
void visitConstructor(ConstructorNode constructorNode) {
processParameters(constructorNode.parameters, '')
super.visitConstructor(constructorNode)
}
void visitClosureExpression(ClosureExpression closureExpression) {
if (isFirstVisit(closureExpression)) {
processParameters(closureExpression.parameters, '')
}
super.visitClosureExpression(closureExpression)
}
private void processParameters(parameters, methodName) {
parameters.each { parameter ->
if (!new WildcardPattern(rule.ignoreParameterNames, false).matches(parameter.name)) {
if (parameter.lineNumber >= 0 && !(parameter.name ==~ rule.regex)) {
addViolation(parameter, "The parameter named $parameter.name in method $methodName of class $currentClassName does not match ${rule.regex.toString()}")
}
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/AbstractRuleTestCase.groovy 0000644 0001750 0001750 00000037076 12444433061 026334 0 ustar ebourg ebourg /*
* Copyright 2012 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
import org.codenarc.analyzer.StringSourceAnalyzer
import org.codenarc.ruleset.ListRuleSet
import org.codenarc.source.CustomCompilerPhaseSourceDecorator
import org.codenarc.source.SourceCode
import org.codenarc.source.SourceString
import org.codenarc.test.AbstractTestCase
import org.junit.Before
import org.junit.Test
import java.util.regex.Pattern
import java.util.regex.PatternSyntaxException
import static org.codenarc.test.TestUtil.assertContainsAll
/**
* Abstract superclass for tests of Rule classes
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
@SuppressWarnings('DuplicateLiteral')
abstract class AbstractRuleTestCase extends AbstractTestCase {
protected static final CONSTRUCTOR_METHOD_NAME = ''
protected static final DEFAULT_TEST_FILES = AbstractAstVisitorRule.DEFAULT_TEST_FILES
protected static final DEFAULT_TEST_CLASS_NAMES = AbstractAstVisitorRule.DEFAULT_TEST_CLASS_NAMES
protected Rule rule
// Subclasses can optionally set these to set the name or path of the SourceCode object created
protected String sourceCodeName
protected String sourceCodePath
//--------------------------------------------------------------------------
// Common Tests - Run for all concrete subclasses
//--------------------------------------------------------------------------
/**
* Make sure that code unrelated to the rule under test causes no violations.
* Subclasses can skip this rule by defining a property named 'skipTestThatUnrelatedCodeHasNoViolations'.
*/
@Test
void testThatUnrelatedCodeHasNoViolations() {
final SOURCE = 'class MyClass { }'
if (!getProperties().keySet().contains('skipTestThatUnrelatedCodeHasNoViolations')) {
assertNoViolations(SOURCE)
}
}
@Test
void testThatInvalidCodeHasNoViolations() {
final SOURCE = '''
@will not compile@ &^%$#
'''
if (!getProperties().keySet().contains('skipTestThatInvalidCodeHasNoViolations')) {
// Verify no errors/exceptions
def sourceCode = prepareSourceCode(SOURCE)
assert rule.applyTo(sourceCode).empty
}
}
@Test
void testThatApplyToFilesMatchingValuesAreValidRegex() {
assertValidRegex(rule.applyToFilesMatching, 'applyToFilesMatching')
assertValidRegex(rule.doNotApplyToFilesMatching, 'doNotApplyToFilesMatching')
}
private void assertValidRegex(String regex, String name) {
if (regex) {
try {
Pattern.compile(regex)
}
catch(PatternSyntaxException e) {
fail("The $name value [$regex] is not a valid regular expression: $e")
}
}
}
//--------------------------------------------------------------------------
// Abstract Method Declarations - Must be implemented by concrete subclasses
//--------------------------------------------------------------------------
/**
* Create and return a new instance of the Rule class to be tested.
* @return a new Rule instance
*/
protected abstract Rule createRule()
/**
* Apply the current Rule to the specified source (String) and assert that it results
* in two violations with the specified line numbers and containing the specified source text values.
* @param source - the full source code to which the rule is applied, as a String
* @param lineNumber1 - the expected line number in the first violation
* @param sourceLineText1 - the text expected within the sourceLine of the first violation
* @param lineNumber2 - the expected line number in the second violation
* @param sourceLineText2 - the text expected within the sourceLine of the second violation
*/
protected void assertTwoViolations(String source,
Integer lineNumber1, String sourceLineText1,
Integer lineNumber2, String sourceLineText2) {
def violations = applyRuleTo(source)
violations.sort { it.lineNumber }
assert violations.size() == 2, "Expected 2 violations\nFound ${violations.size()}: \n${violations.join('\n')}\n"
assertViolation(violations[0], lineNumber1, sourceLineText1)
assertViolation(violations[1], lineNumber2, sourceLineText2)
}
/**
* Apply the current Rule to the specified source (String) and assert that it results
* in the violations specified inline within the source.
*
* Inline violations can be specified either by using the {@link #inlineViolation(java.lang.String)} method
* or simply by prefixing a violation message with a '#'. Multiple inline violations per line are allowed.
*
* One can prevent a '#' character from starting a violation message by escaping it with a '\' character
* (keep in mind that most of Groovy's string literal syntax demands the '\' to be escaped itself,
* as a '\\' sequence).
*
* For every source line all text after the first non-escaped '#' character is part of some inline violation message
* (with the sole exception of the first line of a Groovy script beginning with a shebang).
* More precisely, every '#' character that is neither escaped nor part of a shebang starts an inline violation that
* spans to the end of its line or until next non-escaped '#' character.
*
* See the {@link #inlineViolation(java.lang.String)} method.
* See the {@link #removeInlineViolations(java.lang.String)} method.
*
* @param source - the full source code to which the rule is applied annotated with inline violations, as a String
*/
protected void assertInlineViolations(String annotatedSource) {
def parseResult = new InlineViolationsParser().parse(annotatedSource)
def violationsMap = parseResult.violations as Map[]
assertViolations(parseResult.source, violationsMap)
assert violationsMap, 'There must be at least one inline violation specified. If no violations are intended, then use assertNoViolations() instead'
}
/**
* Prepares an inline violation with a given message, escaping all '#' characters and preventing accidental
* escaping of next inline violation's start when the message ends with a '\' character.
*
* @param violationMessage message for the inline violation
* @return a String that will be interpreted as an inline violation by the
* {@link #assertInlineViolations(java.lang.String)} method
*/
protected static String inlineViolation(String violationMessage) {
return InlineViolationsParser.inlineViolation(violationMessage)
}
/**
* Removes all inline violations from a source.
*
* @param annotatedSource source possibly containing inline violations
* @return the given source with inline violations removed
*/
protected static String removeInlineViolations(String annotatedSource) {
return new InlineViolationsParser().parse(annotatedSource).source
}
/**
* Apply the current Rule to the specified source (String) and assert that it results
* in the violations specified in violationMaps.
* @param source - the full source code to which the rule is applied, as a String
* @param violationMaps - a list (array) of Maps, each describing a single violation.
* Each element in the map can contain a lineNumber, sourceLineText and messageText entries.
*/
protected void assertViolations(String source, Map[] violationMaps) {
def rawViolations = applyRuleTo(source)
rawViolations.sort { v -> v.lineNumber }
assert rawViolations.size() == violationMaps.size(), "Expected ${violationMaps.size()} violations\nFound ${rawViolations.size()}: \n ${rawViolations.join('\n ')}\n"
violationMaps.eachWithIndex { violationMap, index ->
assert violationMap.keySet().every { key -> key in ['lineNumber', 'sourceLineText', 'messageText'] }, "violationMap keys must be 'lineNumber', 'sourceLineText' and/or 'messageText'"
assertViolation(rawViolations[index], violationMap.lineNumber, violationMap.sourceLineText, violationMap.messageText)
}
}
/**
* Apply the current Rule to the specified source (String) and assert that it results
* in two violations with the specified line numbers and containing the specified source text values.
* @param source - the full source code to which the rule is applied, as a String
* @param lineNumber1 - the expected line number in the first violation
* @param sourceLineText1 - the text expected within the sourceLine of the first violation
* @param msg1 - the text expected within the message of the first violation; May be a String or List of Strings; Defaults to null;
* @param lineNumber2 - the expected line number in the second violation
* @param sourceLineText2 - the text expected within the sourceLine of the second violation
* @param msg2 - the text expected within the message of the second violation; May be a String or List of Strings; Defaults to null;
*/
@SuppressWarnings('ParameterCount')
protected void assertTwoViolations(String source,
Integer lineNumber1, String sourceLineText1, msg1,
Integer lineNumber2, String sourceLineText2, msg2) {
def violations = applyRuleTo(source)
assert violations.size() == 2, "Expected 2 violations\nFound ${violations.size()}: \n${violations.join('\n')}\n"
assertViolation(violations[0], lineNumber1, sourceLineText1, msg1)
assertViolation(violations[1], lineNumber2, sourceLineText2, msg2)
}
/**
* Apply the current Rule to the specified source (String) and assert that it results
* in a single violation with the specified line number and containing the specified source text.
* @param source - the full source code to which the rule is applied, as a String
* @param lineNumber - the expected line number in the resulting violation; defaults to null
* @param sourceLineText - the text expected within the sourceLine of the resulting violation; defaults to null
* @param messageText - the text expected within the message of the resulting violation; May be a String or List of Strings; Defaults to null;
*/
protected void assertSingleViolation(String source, Integer lineNumber=null, String sourceLineText=null, messageText=null) {
def violations = applyRuleTo(source)
assert violations.size() == 1, "Expected 1 violation\nFound ${violations.size()}: \n${violations.join('\n')}\n for sourceLineText: [$sourceLineText]"
assertViolation(violations[0], lineNumber, sourceLineText, messageText)
}
/**
* Apply the current Rule to the specified source (String) and assert that it results
* in a single violation and that the specified closure returns true.
* @param source - the full source code to which the rule is applied, as a String; defaults to null
* @param closure - the closure to apply to the violation; takes a single Violation parameter
*/
protected void assertSingleViolation(String source, Closure closure) {
def violations = applyRuleTo(source)
assert violations.size() == 1, "Expected 1 violation\nFound ${violations.size()}: \n${violations.join('\n')}\n"
assert closure(violations[0]), "Closure failed for ${violations[0]}"
}
/**
* Apply the current Rule to the specified source (String) and assert that it results
* in no violations.
* @param source - the full source code to which the rule is applied, as a String
*/
protected void assertNoViolations(String source) {
def violations = applyRuleTo(source)
assert violations.empty, "Expected no violations, but got ${violations.size()}: \n${violations.join('\n')}\n"
}
/**
* Assert that the specified violation is for the current rule, and has expected line number
* and contains the specified source text and message text.
* @param violation - the Violation
* @param lineNumber - the expected line number in the resulting violation
* @param sourceLineText - the text expected within the sourceLine of the resulting violation; may be null
* @param messageText - the text expected within the message of the resulting violation; May be a String or List of Strings; Defaults to null;
*/
protected void assertViolation(
Violation violation,
Integer lineNumber,
String sourceLineText,
messageText=null) {
assert violation.rule == rule
assert violation.lineNumber == lineNumber : "Wrong line number for violation: \n$violation\nExpected: $lineNumber\nFound: $violation.lineNumber\n"
if (sourceLineText) {
assert violation.sourceLine
assert violation.sourceLine.contains(sourceLineText), """Problem with source text:
expected to contain: $sourceLineText
actual: $violation.sourceLine
"""
}
if (messageText) {
assert violation.message, 'The violation message was null'
if (messageText instanceof Collection) {
assertContainsAll(violation.message, messageText)
}
else {
assert violation.message.contains(messageText), "\nExpected message text: [$messageText]\nFound message text: [$violation.message]\n"
}
}
}
/**
* Apply the current Rule to the specified source (String) and return the resulting List of Violations.
* @param source - the full source code to which the rule is applied, as a String
*/
protected List applyRuleTo(String source) {
def sourceCode = prepareSourceCode(source)
assert sourceCode.valid
def violations = rule.applyTo(sourceCode)
log("violations=$violations")
violations
}
private SourceCode prepareSourceCode(String source) {
def sourceCode = new SourceString(source, sourceCodePath, sourceCodeName)
if (rule.compilerPhase != SourceCode.DEFAULT_COMPILER_PHASE) {
sourceCode = new CustomCompilerPhaseSourceDecorator(sourceCode, rule.compilerPhase)
}
sourceCode
}
/**
* Apply the current Rule to the specified source (String) and return the resulting List of Violations.
* @param source - the full source code to which the rule is applied, as a String
*/
protected List manuallyApplyRule(String source) {
def analyzer = new StringSourceAnalyzer(source)
assert analyzer.source.valid
def results = analyzer.analyze(new ListRuleSet([rule]))
results.violations
}
@Before
void setUpAbstractRuleTestCase() {
this.rule = createRule()
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ 0000755 0001750 0001750 00000000000 12623571301 022101 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EqualsAndHashCodeRule.groovy 0000644 0001750 0001750 00000004215 12052037536 027461 0 ustar ebourg ebourg /*
* 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.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that checks that if either the boolean equals(Object) or
* the int hashCode() methods are overridden within a class, then both must be overridden.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class EqualsAndHashCodeRule extends AbstractAstVisitorRule {
String name = 'EqualsAndHashCode'
int priority = 2
Class astVisitorClass = EqualsAndHashCodeAstVisitor
}
class EqualsAndHashCodeAstVisitor extends AbstractAstVisitor {
void visitClassEx(ClassNode classNode) {
def methods = classNode.methods
def equalsMethod = methods.find { m ->
m.name == 'equals' &&
m.parameters.size() == 1 &&
m.parameters[0].type.name in ['Object', 'java.lang.Object']
}
def hashCodeMethod = methods.find { m -> m.name == 'hashCode' && m.parameters.size() == 0 }
def oneButNotBoth = (equalsMethod || hashCodeMethod) && !(equalsMethod && hashCodeMethod)
if (oneButNotBoth) {
if (equalsMethod) {
addViolation(classNode, "The class $classNode.name defines equals(Object) but not hashCode()")
} else {
addViolation(classNode, "The class $classNode.name defines hashCode() but not equals(Object)")
}
}
super.visitClassEx(classNode)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/AbstractFinallyAstVisitor.groovy 0000644 0001750 0001750 00000003360 12311373552 030466 0 ustar ebourg ebourg /*
* Copyright 2008 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.Statement
import org.codehaus.groovy.ast.stmt.TryCatchStatement
import org.codenarc.rule.AbstractAstVisitor
/**
* Abstract superclass for AST Visitor classes that check for conditions within a finally block
*
* @author Chris Mair
*/
abstract class AbstractFinallyAstVisitor extends AbstractAstVisitor {
private final finallyLineRanges = []
// Known pathology: if there is another statement on the same line as the beginning or
// end of the finally block, but outside the block.
void visitTryCatchFinally(TryCatchStatement tryCatchStatement) {
if (tryCatchStatement.finallyStatement) {
def f = tryCatchStatement.finallyStatement
finallyLineRanges.add(f.lineNumber..f.lastLineNumber)
}
super.visitTryCatchFinally(tryCatchStatement)
}
/**
* @return true if the specified statement is within a finally block
*/
protected boolean isStatementWithinFinally(Statement statement) {
finallyLineRanges.find { statement.lineNumber in it }
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyInstanceInitializerRule.groovy 0000644 0001750 0001750 00000003312 12006632012 031156 0 ustar ebourg ebourg /*
* 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.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* The class has an empty instance initializer. It can safely by removed.
*
* @author 'Hamlet D'Arcy'
*/
class EmptyInstanceInitializerRule extends AbstractAstVisitorRule {
String name = 'EmptyInstanceInitializer'
int priority = 2
Class astVisitorClass = EmptyInstanceInitializerAstVisitor
}
class EmptyInstanceInitializerAstVisitor extends AbstractAstVisitor {
@Override
protected void visitObjectInitializerStatements(ClassNode node) {
if (node.objectInitializerStatements.size() == 1 && AstUtil.isEmptyBlock(node.objectInitializerStatements[0])) {
def emptyBlock = AstUtil.getEmptyBlock(node.objectInitializerStatements[0])
if (emptyBlock) {
addViolation(emptyBlock, "The class $node.name defines an empty instance initializer. It is safe to delete it")
}
}
super.visitObjectInitializerStatements(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ForLoopShouldBeWhileLoopRule.groovy 0000644 0001750 0001750 00000004400 12006632014 031021 0 ustar ebourg ebourg /*
* Copyright 2011 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.expr.EmptyExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.ast.stmt.ForStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* For loops where init and update statements are empty can be simplified to while loops.
* Ignores For-Each Loops (for (Plan p : plans) { .. }) and Groovy For Loops (for (p in plans) { .. }).
*
* @author Victor Savkin
*/
class ForLoopShouldBeWhileLoopRule extends AbstractAstVisitorRule {
String name = 'ForLoopShouldBeWhileLoop'
int priority = 3
Class astVisitorClass = ForLoopShouldBeWhileLoopAstVisitor
}
class ForLoopShouldBeWhileLoopAstVisitor extends AbstractAstVisitor {
@Override
void visitForLoop(ForStatement node) {
if(!isForEachLoop(node) && hasOnlyConditionExpr(node)) {
addViolation node, 'The for loop can be simplified to a while loop'
}
super.visitForLoop node
}
private hasOnlyConditionExpr(ForStatement forStatement) {
if (AstUtil.respondsTo(forStatement.collectionExpression, 'expressions')) {
def (init, condition, update) = forStatement.collectionExpression.expressions
return isEmptyExpression(init) && isEmptyExpression(update) && !isEmptyExpression(condition)
}
false
}
private static isEmptyExpression(expr) {
expr instanceof EmptyExpression
}
private boolean isForEachLoop(ForStatement forStatement) {
return forStatement.collectionExpression instanceof VariableExpression
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/MultipleUnaryOperatorsRule.groovy 0000644 0001750 0001750 00000006067 12323627301 030721 0 ustar ebourg ebourg /*
* Copyright 2014 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.expr.BitwiseNegationExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.NotExpression
import org.codehaus.groovy.ast.expr.UnaryMinusExpression
import org.codehaus.groovy.ast.expr.UnaryPlusExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
/**
* Checks for multiple consecutive unary operators. These are confusing, and are likely typos and bugs.
*
* @author Chris Mair
*/
class MultipleUnaryOperatorsRule extends AbstractAstVisitorRule {
String name = 'MultipleUnaryOperators'
int priority = 2
Class astVisitorClass = MultipleUnaryOperatorsAstVisitor
}
class MultipleUnaryOperatorsAstVisitor extends AbstractAstVisitor {
private static final UNARY_OPERATORS = [
(BitwiseNegationExpression):'~',
(NotExpression):'!',
(UnaryMinusExpression):'-',
(UnaryPlusExpression):'+' ]
private static final UNARY_OPERATOR_CLASSES = UNARY_OPERATORS.keySet()
private static final ERROR_MESSAGE = 'The expression (%s) in class %s contains confusing multiple consecutive unary operators'
@Override
void visitBitwiseNegationExpression(BitwiseNegationExpression expression) {
checkForSecondUnaryOperator(expression, BitwiseNegationExpression)
super.visitBitwiseNegationExpression(expression)
}
@Override
void visitNotExpression(NotExpression expression) {
checkForSecondUnaryOperator(expression, NotExpression)
super.visitNotExpression(expression)
}
@Override
void visitUnaryMinusExpression(UnaryMinusExpression expression) {
checkForSecondUnaryOperator(expression, UnaryMinusExpression)
super.visitUnaryMinusExpression(expression)
}
@Override
void visitUnaryPlusExpression(UnaryPlusExpression expression) {
checkForSecondUnaryOperator(expression, UnaryPlusExpression)
super.visitUnaryPlusExpression(expression)
}
private void checkForSecondUnaryOperator(Expression expression, Class firstOperatorClass) {
if (expression.expression.class in UNARY_OPERATOR_CLASSES) {
String operators = UNARY_OPERATORS[firstOperatorClass] + UNARY_OPERATORS[expression.expression.class]
String expressionText = operators + expression.text
addViolation(expression, String.format(ERROR_MESSAGE, expressionText, currentClassName))
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyCatchBlockRule.groovy 0000644 0001750 0001750 00000003344 12311373552 027222 0 ustar ebourg ebourg /*
* 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 {
void visitCatchStatement(CatchStatement catchStatement) {
if (isFirstVisit(catchStatement) && isExceptionIgnored(catchStatement)) {
addViolation(catchStatement, 'The catch block is empty')
}
super.visitCatchStatement(catchStatement)
}
private isExceptionIgnored(catchStatement) {
AstUtil.isEmptyBlock(catchStatement.code) && !doesContainIgnoreWord(catchStatement.variable?.name)
}
private doesContainIgnoreWord(String name) {
name ==~ rule.ignoreRegex
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/BigDecimalInstantiationRule.groovy 0000644 0001750 0001750 00000004153 12461171646 030740 0 ustar ebourg ebourg /*
* 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.basic
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractConstructorCallAstVisitor
/**
* Rule that checks for calls to the BigDecimal constructor with a double or float literal.
* The String literal should be used instead.
*
* @author Chris Mair
*/
class BigDecimalInstantiationRule extends AbstractAstVisitorRule {
String name = 'BigDecimalInstantiation'
int priority = 2
Class astVisitorClass = BigDecimalInstantiationAstVisitor
}
class BigDecimalInstantiationAstVisitor extends AbstractConstructorCallAstVisitor {
static final NEW_BIG_DECIMAL = /new +(java\.math\.)?BigDecimal\(/
@SuppressWarnings('ExplicitCallToGetAtMethod')
protected isConstructorCallAViolation(ConstructorCallExpression constructorCall) {
def firstArgExpression = constructorCall.arguments?.expressions?.getAt(0)
constructorCall.text =~ NEW_BIG_DECIMAL &&
(firstArgExpression instanceof ConstantExpression) &&
(firstArgExpression.type.name in ['java.math.BigDecimal', 'java.lang.Double', 'double'])
}
@Override protected String getViolationMessage(ConstructorCallExpression call) {
"""Call to $call.text uses the double constructor and should probably be replaced with new ${call.type.name}("${call.arguments?.expressions?.first().text}")"""
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/DoubleNegativeRule.groovy 0000644 0001750 0001750 00000002726 12323542260 027103 0 ustar ebourg ebourg /*
* 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.expr.NotExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* There is no point in using a double negative, it is always positive. For instance !!x can always be simplified to x. And !(!x) can as well.
*
* @author Hamlet D'Arcy
*/
class DoubleNegativeRule extends AbstractAstVisitorRule {
String name = 'DoubleNegative'
int priority = 2
Class astVisitorClass = DoubleNegativeAstVisitor
}
class DoubleNegativeAstVisitor extends AbstractAstVisitor {
void visitNotExpression(NotExpression expression) {
if (expression.expression instanceof NotExpression) {
addViolation expression, "The expression (!!$expression.text) is a confusing double negative"
}
super.visitNotExpression expression
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/AssignmentInConditionalRule.groovy 0000644 0001750 0001750 00000005435 12041061502 030761 0 ustar ebourg ebourg /*
* Copyright 2012 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.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.ElvisOperatorExpression
import org.codehaus.groovy.ast.expr.TernaryExpression
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codehaus.groovy.ast.stmt.WhileStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* An assignment operator (=) was used in a conditional test. This is usually a typo, and the comparison operator (==) was intended.
*
* @author 'Hamlet D'Arcy'
* @author Chris Mair
*/
class AssignmentInConditionalRule extends AbstractAstVisitorRule {
String name = 'AssignmentInConditional'
int priority = 2
Class astVisitorClass = AssignmentInConditionalAstVisitor
}
class AssignmentInConditionalAstVisitor extends AbstractAstVisitor {
@Override
void visitIfElse(IfStatement node) {
addViolationIfAssignment(node.booleanExpression.expression)
super.visitIfElse(node)
}
@Override
void visitWhileLoop(WhileStatement node) {
addViolationIfAssignment(node.booleanExpression.expression)
super.visitWhileLoop(node)
}
@Override
void visitTernaryExpression(TernaryExpression node) {
addViolationIfAssignment(node.booleanExpression.expression)
super.visitTernaryExpression(node)
}
@Override
void visitShortTernaryExpression(ElvisOperatorExpression node) {
addViolationIfAssignment(node.booleanExpression.expression)
super.visitShortTernaryExpression(node)
}
private addViolationIfAssignment(node) {
if (isFirstVisit(node) && node instanceof BinaryExpression) {
if (node.operation.text == '=') {
addViolation(node, 'Assignment used as conditional value, which always results in true. Use the == operator instead')
}
else {
if (node.operation.text in ['&&', '||']) {
addViolationIfAssignment(node.leftExpression)
addViolationIfAssignment(node.rightExpression)
}
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/DeadCodeRule.groovy 0000644 0001750 0001750 00000004514 12311370173 025632 0 ustar ebourg ebourg /*
* 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.expr.TernaryExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.stmt.*
/**
* Dead code appears after a return statement or an exception is thrown. If code appears after one of these statements then it will never be executed and can be safely deleted.
*
* @author Hamlet D'Arcy
*/
class DeadCodeRule extends AbstractAstVisitorRule {
String name = 'DeadCode'
int priority = 2
Class astVisitorClass = DeadCodeAstVisitor
}
class DeadCodeAstVisitor extends AbstractAstVisitor {
void visitBlockStatement(BlockStatement block) {
if (block.statements && block.statements.size() >= 2) {
(block.statements.size() - 1).times {
def statement = block.statements[it]
if (statementForcesMethodReturn(statement)) {
addViolation (block.statements[it + 1], 'This code cannot be reached')
}
}
}
super.visitBlockStatement block
}
private boolean statementForcesMethodReturn(Statement statement) {
if (statement instanceof ReturnStatement ) { return true }
if (statement instanceof ThrowStatement ) { return true }
if (statement instanceof IfStatement) {
return statementForcesMethodReturn(statement.ifBlock) && statementForcesMethodReturn(statement.elseBlock)
}
if (statement instanceof TernaryExpression) {
return statementForcesMethodReturn(statement.trueExpression) && statementForcesMethodReturn(statement.falseExpression)
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyStaticInitializerRule.groovy 0000644 0001750 0001750 00000003062 12006632016 030647 0 ustar ebourg ebourg /*
* 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.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
/**
* An empty static initializer was found. It is safe to remove it.
*
* @author Hamlet D'Arcy
*/
class EmptyStaticInitializerRule extends AbstractAstVisitorRule {
String name = 'EmptyStaticInitializer'
int priority = 2
Class astVisitorClass = EmptyStaticInitializerAstVisitor
}
class EmptyStaticInitializerAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
if (node.name == '' && AstUtil.isEmptyBlock(node.code)) {
def emptyBlock = AstUtil.getEmptyBlock(node.code)
if (emptyBlock) {
addViolation(emptyBlock, "The class ${node?.declaringClass?.name} has an empty static initializer. It is safe to delete it")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/HardCodedWindowsFileSeparatorRule.groovy 0000644 0001750 0001750 00000004504 12141451332 032050 0 ustar ebourg ebourg /*
* Copyright 2011 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.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.*
/**
* This rule finds usages of a Windows file separator within the constructor call of a File object. It is better to use the Unix file separator or use the File.separator constant.
*
* @author Hamlet D'Arcy
*/
class HardCodedWindowsFileSeparatorRule extends AbstractAstVisitorRule {
String name = 'HardCodedWindowsFileSeparator'
int priority = 2
Class astVisitorClass = HardCodedWindowsFileSeparatorAstVisitor
}
class HardCodedWindowsFileSeparatorAstVisitor extends AbstractAstVisitor {
@Override
void visitConstructorCallExpression(ConstructorCallExpression call) {
if (isFirstVisit(call)) {
if (AstUtil.isConstructorCall(call, 'File') && call.arguments instanceof ArgumentListExpression) {
for (Expression exp : call.arguments.expressions) {
addViolationForWindowsSeparator(exp)
}
}
super.visitConstructorCallExpression(call)
}
}
private void addViolationForWindowsSeparator(Expression expression) {
if (expression instanceof ConstantExpression && expression.value instanceof String) {
if (expression.value.contains('\\')) {
addViolation(expression, 'The windows file separator is not portable')
}
} else if (expression instanceof GStringExpression) {
if (expression.strings && expression.strings[0].value.contains('\\')) {
addViolation(expression, 'The windows file separator is not portable')
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptySynchronizedStatementRule.groovy 0000644 0001750 0001750 00000003076 12311373552 031573 0 ustar ebourg ebourg /*
* 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.SynchronizedStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for empty synchronized statement
*
* @author Chris Mair
*/
class EmptySynchronizedStatementRule extends AbstractAstVisitorRule {
String name = 'EmptySynchronizedStatement'
int priority = 2
Class astVisitorClass = EmptySynchronizedStatementAstVisitor
}
class EmptySynchronizedStatementAstVisitor extends AbstractAstVisitor {
void visitSynchronizedStatement(SynchronizedStatement synchronizedStatement) {
if (isFirstVisit(synchronizedStatement) && AstUtil.isEmptyBlock(synchronizedStatement.code)) {
addViolation(synchronizedStatement, 'The synchronized statement is empty')
}
super.visitSynchronizedStatement(synchronizedStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/RemoveAllOnSelfRule.groovy 0000644 0001750 0001750 00000003747 12006632014 027202 0 ustar ebourg ebourg /*
* 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.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.TupleExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
/**
* This rule catches calling the method removeAll with yourself as a parameter.
*
* @author Hamlet D'Arcy
*/
class RemoveAllOnSelfRule extends AbstractAstVisitorRule {
String name = 'RemoveAllOnSelf'
int priority = 2
Class astVisitorClass = RemoveAllOnSelfAstVisitor
}
class RemoveAllOnSelfAstVisitor extends AbstractMethodCallExpressionVisitor {
void visitMethodCallExpression(MethodCallExpression call) {
if (isMethodNamed(call, 'removeAll') && getArity(call) == 1) {
String variableName = call.objectExpression.text
def argumentName = call.arguments.expressions[0].text
if (argumentName == variableName) {
addViolation call, "A call to $call.text can be replaced with ${call.objectExpression.text}.clear()"
}
}
}
private static boolean isMethodNamed(MethodCallExpression call, target) {
call?.method?.text == target
}
private static int getArity(MethodCallExpression call) {
if (call?.arguments instanceof TupleExpression) {
return call?.arguments?.expressions?.size()
}
0
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ExplicitGarbageCollectionRule.groovy 0000644 0001750 0001750 00000005415 12006632014 031245 0 ustar ebourg ebourg /*
* 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.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.*
/**
* Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised. Code should have the
* same behavior whether the garbage collection is disabled using the option -Xdisableexplicitgc or not. Moreover,
* "modern" jvms do a very good job handling garbage collections. If memory usage issues unrelated to memory leaks
* develop within an application, it should be dealt with JVM options rather than within the code itself.
*
* @author 'Hamlet D'Arcy'
*/
class ExplicitGarbageCollectionRule extends AbstractAstVisitorRule {
String name = 'ExplicitGarbageCollection'
int priority = 2
Class astVisitorClass = ExplicitGarbageCollectionAstVisitor
}
class ExplicitGarbageCollectionAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, ['System'], ['gc', 'runFinalization'], 0)) {
addViolation call, 'Garbage collection should not be explicitly forced'
} else if (AstUtil.isMethodNamed(call, 'gc', 0)) {
if (isPropertyExpression(call.objectExpression, 'Runtime', 'runtime')) {
addViolation call, 'Garbage collection should not be explicitly forced'
} else if (AstUtil.isMethodCall(call.objectExpression, 'Runtime', 'getRuntime', 0)) {
addViolation call, 'Garbage collection should not be explicitly forced'
}
}
}
private static boolean isPropertyExpression(Expression expression, String object, String propertyName) {
if (!(expression instanceof PropertyExpression)) {
return false
}
if (expression.property instanceof ConstantExpression && expression.property.value == propertyName) {
if (expression.objectExpression instanceof VariableExpression && expression.objectExpression.variable == object) {
return true
}
}
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/DuplicateMapKeyRule.groovy 0000644 0001750 0001750 00000003560 12006632016 027221 0 ustar ebourg ebourg /*
* Copyright 2011 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.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.MapExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* A map literal is created with duplicated key. The map entry will be overwritten.
*
* @author 'Łukasz Indykiewicz'
*/
class DuplicateMapKeyRule extends AbstractAstVisitorRule {
String name = 'DuplicateMapKey'
int priority = 2
Class astVisitorClass = DuplicateMapKeyAstVisitor
}
class DuplicateMapKeyAstVisitor extends AbstractAstVisitor {
@Override
@SuppressWarnings('UnnecessaryCollectCall')
void visitMapExpression(MapExpression expression) {
if(isFirstVisit(expression)) {
def a = expression.mapEntryExpressions
.findAll { it.keyExpression instanceof ConstantExpression }
.collect { it.keyExpression }
a.inject([]) { result, it ->
if (result.contains(it.value)) {
addViolation(it, "Key '${it.value}' is duplicated.")
} else {
result.add(it.value)
}
result
}
super.visitMapExpression(expression)
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/DuplicateCaseStatementRule.groovy 0000644 0001750 0001750 00000003606 12006632014 030572 0 ustar ebourg ebourg /*
* 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.basic
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.stmt.CaseStatement
import org.codehaus.groovy.ast.stmt.SwitchStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that checks for duplicate case statements in a switch block, such as two
* equal integers or strings.
*
* @author Hamlet D'Arcy
*/
class DuplicateCaseStatementRule extends AbstractAstVisitorRule {
String name = 'DuplicateCaseStatement'
int priority = 2
Class astVisitorClass = DuplicateCaseStatementAstVisitor
}
class DuplicateCaseStatementAstVisitor extends AbstractAstVisitor {
void visitSwitch(SwitchStatement statement) {
def allElements = statement?.caseStatements?.findAll { it?.expression instanceof ConstantExpression }
allElements.inject([]) { list, CaseStatement item ->
if (list.contains(item?.expression?.value)) {
addViolation(item, "Duplicate case statements found in switch. $item?.expression?.value appears twice")
}
else {
list.add item.expression?.value
}
list
}
super.visitSwitch(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/AssertWithinFinallyBlockRule.groovy 0000644 0001750 0001750 00000003035 12311373552 031121 0 ustar ebourg ebourg /*
* Copyright 2012 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.AssertStatement
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that checks for assert statements within a finally block.
*
* @author Chris Mair
*/
class AssertWithinFinallyBlockRule extends AbstractAstVisitorRule {
String name = 'AssertWithinFinallyBlock'
int priority = 2
Class astVisitorClass = AssertWithinFinallyBlockAstVisitor
}
class AssertWithinFinallyBlockAstVisitor extends AbstractFinallyAstVisitor {
@Override
void visitAssertStatement(AssertStatement statement) {
if (isFirstVisit(statement) && isStatementWithinFinally(statement)) {
addViolation(statement, "A finally block within class $currentClassName contains an assert statement, potentially hiding the original exception, if there is one")
}
super.visitAssertStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ConstantTernaryExpressionRule.groovy 0000644 0001750 0001750 00000005207 12311373552 031424 0 ustar ebourg ebourg /*
* 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.basic
import org.codehaus.groovy.ast.expr.TernaryExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for ternary expressions with a constant value for the boolean expression, such as:
*
*
true ? x : y
*
false ? x : y
*
Boolean.TRUE ? x : y
*
Boolean.FALSE ? x : y
*
null ? x : y
*
0 ? x : y
*
99.7 ? x : y
*
"" ? x : y
*
"abc" ? x : y
*
[:] ? x : y
*
[a:123, b:456] ? x : y
*
[a, b, c] ? x : y
*
*
* Also checks for the same types of constant values for the boolean expressions within the "short"
* ternary expressions, also known as the "Elvis" operator, e.g.:
*
*
true ?: y
*
null ?: y
*
99.7 ?: y
*
"abc" ?: y
*
[a:123] ?: y
*
*
* @author Chris Mair
*/
class ConstantTernaryExpressionRule extends AbstractAstVisitorRule {
String name = 'ConstantTernaryExpression'
int priority = 2
Class astVisitorClass = ConstantTernaryExpressionAstVisitor
}
class ConstantTernaryExpressionAstVisitor extends AbstractAstVisitor {
void visitTernaryExpression(TernaryExpression ternaryExpression) {
if (isFirstVisit(ternaryExpression)) {
def booleanExpression = ternaryExpression.booleanExpression
if (AstUtil.isConstantOrLiteral(booleanExpression.expression)) {
addViolation(ternaryExpression, "The ternary expression contains the constant $booleanExpression.expression")
}
}
super.visitTernaryExpression(ternaryExpression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyWhileStatementRule.groovy 0000644 0001750 0001750 00000002721 12311373552 030160 0 ustar ebourg ebourg /*
* 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.WhileStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for empty while statements
*
* @author Chris Mair
*/
class EmptyWhileStatementRule extends AbstractAstVisitorRule {
String name = 'EmptyWhileStatement'
int priority = 2
Class astVisitorClass = EmptyWhileStatementAstVisitor
}
class EmptyWhileStatementAstVisitor extends AbstractAstVisitor {
void visitWhileLoop(WhileStatement whileStatement) {
if (isFirstVisit(whileStatement) && AstUtil.isEmptyBlock(whileStatement.loopBlock)) {
addViolation(whileStatement, 'The while statement is empty')
}
super.visitWhileLoop(whileStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ComparisonOfTwoConstantsRule.groovy 0000644 0001750 0001750 00000005306 12006632014 031164 0 ustar ebourg ebourg /*
* Copyright 2011 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.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* CodeNarc Rule. Checks for using a comparison operator or equals() or compareTo() to compare two
* constants to each other or two literal that contain only constant values, e.g.:
* 23 == 67, [3,2] != [1,2]
* Boolean.FALSE != false
* 23 < 88, 0.17 <= 0.99, "abc" > "ddd", [a] >= [x],
* [a:1] <=> [a:99.87]
* [1,2].equals([17,true])
* [a:1].compareTo([a:3])
*
* @author Chris Mair
*/
class ComparisonOfTwoConstantsRule extends AbstractAstVisitorRule {
String name = 'ComparisonOfTwoConstants'
int priority = 2
Class astVisitorClass = ComparisonOfTwoConstantsAstVisitor
}
class ComparisonOfTwoConstantsAstVisitor extends AbstractAstVisitor {
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (isFirstVisit(expression) && AstUtil.isBinaryExpressionType(expression, AstUtil.COMPARISON_OPERATORS)) {
def left = expression.leftExpression
def right = expression.rightExpression
addViolationIfBothAreConstantsOrLiterals(expression, left, right)
}
super.visitBinaryExpression(expression)
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (isFirstVisit(call) && (AstUtil.isMethodCall(call, 'equals', 1) || AstUtil.isMethodCall(call, 'compareTo', 1))) {
def left = call.objectExpression
def right = call.arguments.getExpression(0)
addViolationIfBothAreConstantsOrLiterals(call, left, right)
}
super.visitMethodCallExpression(call)
}
private void addViolationIfBothAreConstantsOrLiterals(node, left, right) {
if (AstUtil.isConstantOrConstantLiteral(left) && AstUtil.isConstantOrConstantLiteral(right)) {
addViolation(node, "Comparing two constants or constant literals is useless and may indicate a bug: ${node.text}")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/IntegerGetIntegerRule.groovy 0000644 0001750 0001750 00000003730 12006632020 027545 0 ustar ebourg ebourg /*
* Copyright 2011 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.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* This rule catches usages of java.lang.Integer.getInteger(String, ...) which reads an Integer from the System properties.
* It is often mistakenly used to attempt to read user input or parse a String into an Integer. It is a poor piece of API
* to use; replace it with System.properties['prop'].
*
* @author 'Hamlet D'Arcy'
*/
class IntegerGetIntegerRule extends AbstractAstVisitorRule {
String name = 'IntegerGetInteger'
int priority = 2
Class astVisitorClass = IntegerGetIntegerAstVisitor
}
class IntegerGetIntegerAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, 'Integer', 'getInteger', 1)) {
addViolation call, 'Integer.getInteger(String) is a confusing API for reading System properties. Prefer the System.getProperty(String) API.'
} else if (AstUtil.isMethodCall(call, 'Integer', 'getInteger', 2)) {
addViolation call, 'Integer.getInteger(String, Integer) is a confusing API for reading System properties. Prefer the System.getProperty(String) API.'
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyClassRule.groovy 0000644 0001750 0001750 00000004675 12170526114 026277 0 ustar ebourg ebourg /*
* Copyright 2013 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.ClassNode
import org.codehaus.groovy.ast.InnerClassNode
import org.codenarc.rule.AbstractRule
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
/**
* Reports classes without methods, fields or properties.
*
* Ignores interfaces, Enums, anonymous inner classes, subclasses (extends), and classes with annotations.
*
* @author Artur Gajowy
*/
class EmptyClassRule extends AbstractRule {
String name = 'EmptyClass'
int priority = 2
@Override
void applyTo(SourceCode sourceCode, List violations) {
sourceCode.ast?.classes?.each { classNode ->
if (
!classNode.isInterface() &&
!classNode.isEnum() &&
!isAnonymousInnerClass(classNode) &&
!isSubclass(classNode) &&
!hasAnnotation(classNode) &&
isEmpty(classNode)) {
violations << createViolation(sourceCode, classNode, violationMessage(classNode))
}
}
}
private boolean isSubclass(ClassNode classNode) {
return classNode.superClass.name != 'java.lang.Object'
}
private boolean hasAnnotation(ClassNode classNode) {
return classNode.getAnnotations()
}
private boolean isAnonymousInnerClass(ClassNode classNode) {
return classNode instanceof InnerClassNode && classNode.isAnonymous()
}
private boolean isEmpty(ClassNode classNode) {
classNode.with {
[methods, declaredConstructors, fields].every { it.isEmpty() }
}
}
private String violationMessage(ClassNode classNode) {
def name = classNode.nameWithoutPackage
"Class '$name' is empty (has no methods, fields or properties). Why would you need a class like this?"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/HardCodedWindowsRootDirectoryRule.groovy 0000644 0001750 0001750 00000004547 12141451376 032137 0 ustar ebourg ebourg /*
* Copyright 2011 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.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
import org.codehaus.groovy.ast.expr.*
/**
* This rule find cases where a File object is constructed with a windows-based path. This is not portable, and using the File.listRoots() method is a better alternative.
*
* @author Hamlet D'Arcy
*/
class HardCodedWindowsRootDirectoryRule extends AbstractAstVisitorRule {
String name = 'HardCodedWindowsRootDirectory'
int priority = 2
Class astVisitorClass = HardcodedWindowsRootDirectoryAstVisitor
}
class HardcodedWindowsRootDirectoryAstVisitor extends AbstractAstVisitor {
@Override
void visitConstructorCallExpression(ConstructorCallExpression call) {
if (isFirstVisit(call)) {
if (AstUtil.isConstructorCall(call, 'File') && call.arguments instanceof ArgumentListExpression) {
for (Expression exp : call.arguments.expressions) {
addViolationForWindowsPath(exp)
}
}
super.visitConstructorCallExpression(call)
}
}
private void addViolationForWindowsPath(Expression expression) {
if (expression instanceof ConstantExpression && expression.value instanceof String) {
if (expression.value ==~ /[a-zA-Z]:\\.*/) {
addViolation(expression, "The file location ${expression.value[0..2]} is not portable")
}
} else if (expression instanceof GStringExpression) {
if (expression.strings && expression.strings[0].value ==~ /[a-zA-Z]:\\.*/) {
addViolation(expression, "The file location ${expression.strings[0].value[0..2]} is not portable")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyForStatementRule.groovy 0000644 0001750 0001750 00000002663 12311373552 027643 0 ustar ebourg ebourg /*
* 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.ForStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for empty for statements
*
* @author Chris Mair
*/
class EmptyForStatementRule extends AbstractAstVisitorRule {
String name = 'EmptyForStatement'
int priority = 2
Class astVisitorClass = EmptyForStatementAstVisitor
}
class EmptyForStatementAstVisitor extends AbstractAstVisitor {
void visitForLoop(ForStatement forStatement) {
if (isFirstVisit(forStatement) && AstUtil.isEmptyBlock(forStatement.loopBlock)) {
addViolation(forStatement, 'The for statement is empty')
}
super.visitForLoop(forStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EqualsOverloadedRule.groovy 0000644 0001750 0001750 00000004265 12311370173 027444 0 ustar ebourg ebourg /*
* Copyright 2011 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.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
/**
* The class has an equals method, but the parameter of the method is not of type Object. It is not overriding equals but instead overloading it.
*
* @author Hamlet D'Arcy,
* @author Artur Gajowy
* @author Marcin Smialek
*
*/
class EqualsOverloadedRule extends AbstractAstVisitorRule {
String name = 'EqualsOverloaded'
int priority = 2
Class astVisitorClass = EqualsOverloadedAstVisitor
}
class EqualsOverloadedAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
if (AstUtil.isMethodNode(node, 'equals')) {
addViolationIfOverloaded(node)
}
}
private void addViolationIfOverloaded(MethodNode method) {
if (!(isEqualsMethodWithOneArgument(method) && onlyArgumentHasTypeObject(method))) {
addViolation(method, "The class $method.declaringClass.name overloads the equals method, it does not override it.")
}
}
private static boolean isEqualsMethodWithOneArgument(MethodNode method) {
AstUtil.isMethodNode(method, 'equals', 1)
}
private static boolean onlyArgumentHasTypeObject(MethodNode method) {
if (method.parameters[0].type.name == 'Object') { return true }
if (method.parameters[0].type.name == 'java.lang.Object') { return true }
false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyIfStatementRule.groovy 0000644 0001750 0001750 00000002642 12311373552 027450 0 ustar ebourg ebourg /*
* 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.IfStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for empty if statements
*
* @author Chris Mair
*/
class EmptyIfStatementRule extends AbstractAstVisitorRule {
String name = 'EmptyIfStatement'
int priority = 2
Class astVisitorClass = EmptyIfStatementAstVisitor
}
class EmptyIfStatementAstVisitor extends AbstractAstVisitor {
void visitIfElse(IfStatement ifStatement) {
if (isFirstVisit(ifStatement) && AstUtil.isEmptyBlock(ifStatement.ifBlock)) {
addViolation(ifStatement, 'The if statement is empty')
}
super.visitIfElse(ifStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyTryBlockRule.groovy 0000644 0001750 0001750 00000002721 12311373552 026754 0 ustar ebourg ebourg /*
* 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.TryCatchStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for empty try blocks
*
* @author Chris Mair
*/
class EmptyTryBlockRule extends AbstractAstVisitorRule {
String name = 'EmptyTryBlock'
int priority = 2
Class astVisitorClass = EmptyTryBlockAstVisitor
}
class EmptyTryBlockAstVisitor extends AbstractAstVisitor {
void visitTryCatchFinally(TryCatchStatement tryCatchStatement) {
if (isFirstVisit(tryCatchStatement) && AstUtil.isEmptyBlock(tryCatchStatement.tryStatement)) {
addViolation(tryCatchStatement, 'The try block is empty')
}
super.visitTryCatchFinally(tryCatchStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ReturnFromFinallyRule.groovy 0000644 0001750 0001750 00000002674 12311373552 027635 0 ustar ebourg ebourg /*
* Copyright 2008 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.ReturnStatement
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that checks for a return from within a finally block
*
* @author Chris Mair
*/
class ReturnFromFinallyBlockRule extends AbstractAstVisitorRule {
String name = 'ReturnFromFinallyBlock'
int priority = 2
Class astVisitorClass = ReturnFromFinallyBlockAstVisitor
}
class ReturnFromFinallyBlockAstVisitor extends AbstractFinallyAstVisitor {
void visitReturnStatement(ReturnStatement returnStatement) {
if (isFirstVisit(returnStatement) && isStatementWithinFinally(returnStatement)) {
addViolation(returnStatement, 'finally statements cannot return a value')
}
super.visitReturnStatement(returnStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/BrokenOddnessCheckRule.groovy 0000644 0001750 0001750 00000005467 12006632012 027702 0 ustar ebourg ebourg /*
* 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.expr.BinaryExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1).
* If this code is intending to check for oddness, consider using x & 1 == 1, or x % 2 != 0.
*
* @author 'Hamlet D'Arcy'
*/
class BrokenOddnessCheckRule extends AbstractAstVisitorRule {
String name = 'BrokenOddnessCheck'
int priority = 2
Class astVisitorClass = BrokenOddnessCheckAstVisitor
}
class BrokenOddnessCheckAstVisitor extends AbstractAstVisitor {
@SuppressWarnings('NestedBlockDepth') // this code isn't that bad
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (AstUtil.isBinaryExpressionType(expression, '==')) {
if (AstUtil.isBinaryExpressionType(expression.leftExpression, '%')) {
if (AstUtil.isConstant(expression.rightExpression, 1)) {
BinaryExpression modExp = expression.leftExpression
if (AstUtil.isConstant(modExp.rightExpression, 2)) {
def variable = modExp.leftExpression.text
addViolation(expression, "The code uses '($variable % 2 == 1)' to check for oddness, which does not work for negative numbers. Use ($variable & 1 == 1) or ($variable % 2 != 0) instead")
}
}
} else if (AstUtil.isBinaryExpressionType(expression.rightExpression, '%')) {
if (AstUtil.isConstant(expression.leftExpression, 1)) {
BinaryExpression modExp = expression.rightExpression
if (AstUtil.isConstant(modExp.rightExpression, 2)) {
def variable = modExp.leftExpression.text
addViolation(expression, "The code uses '(1 == $variable % 2)' to check for oddness, which does not work for negative numbers. Use ($variable & 1 == 1) or ($variable % 2 != 0) instead")
}
}
}
}
super.visitBinaryExpression(expression)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyElseBlockRule.groovy 0000644 0001750 0001750 00000002642 12311373552 027070 0 ustar ebourg ebourg /*
* 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.IfStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for empty else blocks
*
* @author Chris Mair
*/
class EmptyElseBlockRule extends AbstractAstVisitorRule {
String name = 'EmptyElseBlock'
int priority = 2
Class astVisitorClass = EmptyElseBlockAstVisitor
}
class EmptyElseBlockAstVisitor extends AbstractAstVisitor {
void visitIfElse(IfStatement ifStatement) {
if (isFirstVisit(ifStatement) && AstUtil.isEmptyBlock(ifStatement.elseBlock)) {
addViolation(ifStatement.elseBlock, 'The else block is empty')
}
super.visitIfElse(ifStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/RandomDoubleCoercedToZeroRule.groovy 0000644 0001750 0001750 00000010700 12006632012 031171 0 ustar ebourg ebourg /*
* Copyright 2011 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.FieldNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.expr.CastExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.TernaryExpression
import org.codehaus.groovy.ast.stmt.ReturnStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* The Math.random() method returns a double result greater than or equal to 0.0 and less than 1.0. If you coerce this
* result into an Integer or int, then it is coerced to zero. Casting the result to int, or assigning it to an int
* field is probably a bug.
*
* @author Hamlet D'Arcy
*/
class RandomDoubleCoercedToZeroRule extends AbstractAstVisitorRule {
String name = 'RandomDoubleCoercedToZero'
int priority = 2
Class astVisitorClass = RandomDoubleCoercedToZeroAstVisitor
}
class RandomDoubleCoercedToZeroAstVisitor extends AbstractAstVisitor {
@Override
void visitCastExpression(CastExpression expression) {
if (isFirstVisit(expression)) {
if (AstUtil.isMethodCall(expression.expression, 'Math', 'random', 0)) {
if (expression.type?.name == 'long' || expression.type?.name == 'Long') {
addViolation(expression, "Casting the result of Math.random() to a ${expression.type.name} always results in 0")
} else if (expression.type?.name == 'int' || expression.type?.name == 'Integer') {
addViolation(expression, "Casting the result of Math.random() to an ${expression.type.name} always results in 0")
}
}
}
super.visitCastExpression(expression)
}
@Override
void visitField(FieldNode node) {
if (isFirstVisit(node)) {
if (node.initialExpression && AstUtil.isMethodCall(node.initialExpression, 'Math', 'random', 0)) {
if (node.type?.name == 'long' || node.type?.name == 'Long') {
addViolation(node, "Assigning the result of Math.random() to a ${node.type.name} always results in 0")
} else if (node.type?.name == 'int' || node.type?.name == 'Integer') {
addViolation(node, "Assigning the result of Math.random() to an ${node.type.name} always results in 0")
}
}
}
super.visitField(node)
}
@Override
void visitMethodEx(MethodNode node) {
if (isFirstVisit(node)) {
if (node.returnType.name in ['int', 'Integer']) {
node.code?.visit(new MathRandomTracker(callbackFunction: {
addViolation(it, "Returning the result of Math.random() from an ${node.returnType.name}-returning method always returns 0")
}))
}
if (node.returnType.name in ['long', 'Long']) {
node.code?.visit(new MathRandomTracker(callbackFunction: {
addViolation(it, "Returning the result of Math.random() from a ${node.returnType.name}-returning method always returns 0")
}))
}
}
}
}
class MathRandomTracker extends AbstractAstVisitor {
def callbackFunction
void visitReturnStatement(ReturnStatement statement) {
callBackForMathRandomReturns(statement.expression)
super.visitReturnStatement(statement)
}
private callBackForMathRandomReturns(Expression exp) {
def stack = [exp] as Stack
while (stack) {
def expression = stack.pop()
if (AstUtil.isMethodCall(expression, 'Math', 'random', 0)) {
callbackFunction(expression)
} else if (expression instanceof TernaryExpression) {
stack.push(expression.trueExpression)
stack.push(expression.falseExpression)
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptySwitchStatementRule.groovy 0000644 0001750 0001750 00000002653 12311373552 030355 0 ustar ebourg ebourg /*
* 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.SwitchStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that checks for empty switch statements
*
* @author Chris Mair
*/
class EmptySwitchStatementRule extends AbstractAstVisitorRule {
String name = 'EmptySwitchStatement'
int priority = 2
Class astVisitorClass = EmptySwitchStatementAstVisitor
}
class EmptySwitchStatementAstVisitor extends AbstractAstVisitor {
void visitSwitch(SwitchStatement switchStatement) {
if (isFirstVisit(switchStatement) && switchStatement.caseStatements.empty) {
addViolation(switchStatement, 'The switch statement is empty')
}
super.visitSwitch(switchStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ClassForNameRule.groovy 0000644 0001750 0001750 00000003306 12006632016 026513 0 ustar ebourg ebourg /*
* Copyright 2011 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.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* Using Class.forName(...) is a common way to add dynamic behavior to a system. However, using this method can cause resource leaks because the classes can be pinned in memory for long periods of time.
*
* @author 'Hamlet D'Arcy'
*/
class ClassForNameRule extends AbstractAstVisitorRule {
String name = 'ClassForName'
int priority = 2
Class astVisitorClass = ClassForNameAstVisitor
}
class ClassForNameAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression node) {
if (AstUtil.isMethodCall(node, 'Class', 'forName', 1) || AstUtil.isMethodCall(node, 'Class', 'forName', 3)) {
addViolation(node, 'Methods calls to Class.forName(...) can create resource leaks and should almost always be replaced with calls to ClassLoader.loadClass(...)')
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/BrokenNullCheckRule.groovy 0000644 0001750 0001750 00000011632 12041642016 027210 0 ustar ebourg ebourg /*
* Copyright 2012 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 static org.codenarc.util.AstUtil.isNull
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codehaus.groovy.ast.expr.*
/**
* Looks for faulty checks for null in boolean conditions, e.g.
* if (name != null || name.length > 0) { }
* if (name != null || name.size() > 0) { }
* if (string == null && string.equals("")) { }
*
* @author Chris Mair
*/
class BrokenNullCheckRule extends AbstractAstVisitorRule {
String name = 'BrokenNullCheck'
int priority = 2
Class astVisitorClass = BrokenNullCheckAstVisitor
}
class BrokenNullCheckAstVisitor extends AbstractAstVisitor {
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (isFirstVisit(expression)) {
if (expression.leftExpression instanceof BinaryExpression) {
if (isBrokenNullCheck(expression, '||', '!=') || isBrokenNullCheck(expression, '&&', '==')) {
addViolation(expression, "The expression ${expression.text} within class $currentClassName incorrectly checks for null, and can throw a NullPointerException.")
}
}
}
super.visitBinaryExpression(expression)
}
private boolean isBrokenNullCheck(BinaryExpression expression, String andOrOperator, String comparisonWithNullOperator) {
if (expression.operation.text == andOrOperator) {
def leftBinary = expression.leftExpression
def rightBinary = expression.rightExpression
if (isComparisonWithNull(leftBinary, comparisonWithNullOperator)) {
def varName = leftBinary.leftExpression.name
if (isExpressionAccessingMemberNamed(rightBinary, varName)) {
return true
}
}
}
return false
}
private boolean isExpressionAccessingMemberNamed(Expression rightBinary, varName) {
return isPropertyAccessForName(rightBinary, varName) || isMethodCallOnName(rightBinary, varName)
}
private boolean isComparisonWithNull(BinaryExpression expression, String operation) {
return expression.leftExpression instanceof VariableExpression &&
expression.operation.text == operation &&
isNull(expression.rightExpression)
}
private boolean isPropertyAccessForName(Expression expression, String varName) {
boolean isDirectPropertyAccess =
expression instanceof PropertyExpression &&
expression.objectExpression instanceof VariableExpression &&
expression.objectExpression.name == varName
return isDirectPropertyAccess ||
isBinaryExpressionWithPropertyAccessForName(expression, varName) ||
isNotExpressionWithPropertyAccessForName(expression, varName)
}
private boolean isBinaryExpressionWithPropertyAccessForName(Expression expression, String varName) {
return expression instanceof BinaryExpression &&
isPropertyAccessForName(expression.leftExpression, varName)
}
private boolean isNotExpressionWithPropertyAccessForName(Expression expression, String varName) {
return expression instanceof NotExpression &&
isPropertyAccessForName(expression.expression, varName)
}
private boolean isMethodCallOnName(Expression expression, String varName) {
boolean isDirectMethodCall = expression instanceof MethodCallExpression &&
expression.objectExpression instanceof VariableExpression &&
expression.objectExpression.name == varName
return isDirectMethodCall ||
isBinaryExpressionWithMethodCallOnName(expression, varName) ||
isNotExpressionWithMethodCallOnName(expression, varName)
}
private boolean isBinaryExpressionWithMethodCallOnName(Expression expression, String varName) {
return expression instanceof BinaryExpression &&
isMethodCallOnName(expression.leftExpression, varName)
}
private boolean isNotExpressionWithMethodCallOnName(Expression expression, String varName) {
return expression instanceof NotExpression &&
isMethodCallOnName(expression.expression, varName)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/DuplicateSetValueRule.groovy 0000644 0001750 0001750 00000005264 12311370173 027570 0 ustar ebourg ebourg /*
* Copyright 2011 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.ASTNode
import org.codehaus.groovy.ast.expr.CastExpression
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.ListExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
/**
* A Set literal is created with duplicate constant value. A set cannot contain two elements with the same value.
*
* @author Hamlet D'Arcy
*/
class DuplicateSetValueRule extends AbstractAstVisitorRule {
String name = 'DuplicateSetValue'
int priority = 2
Class astVisitorClass = DuplicateSetValueAstVisitor
}
class DuplicateSetValueAstVisitor extends AbstractAstVisitor {
@Override
void visitCastExpression(CastExpression expression) {
if (isSetLiteral(expression)) {
expression.expression.expressions?.inject([]) { acc, value ->
if (isDuplicate(value, acc)) {
addViolationForDuplicate(value)
}
acc
}
}
super.visitCastExpression(expression)
}
private static boolean isDuplicate(ASTNode expression, previousValues) {
if ((expression instanceof ConstantExpression)) {
if (previousValues.contains(expression.value)) {
return true
}
previousValues.add(expression.value)
}
false
}
private addViolationForDuplicate(ConstantExpression constant) {
if (constant.value == null) {
addViolation(constant, 'The constant value null is duplicated in the Set literal')
} else if (constant.value instanceof String) {
addViolation(constant, "The constant value '$constant.value' is duplicated in the Set literal")
} else {
addViolation(constant, "The constant value $constant.value is duplicated in the Set literal")
}
}
private static boolean isSetLiteral(CastExpression expression) {
return expression.type?.name?.endsWith('Set') && expression.expression instanceof ListExpression
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ThrowExceptionFromFinallyRule.groovy 0000644 0001750 0001750 00000002777 12311373552 031344 0 ustar ebourg ebourg /*
* 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.ThrowStatement
import org.codenarc.rule.AbstractAstVisitorRule
/**
* Rule that checks for throwing an exception from within a finally block
*
* @author Chris Mair
*/
class ThrowExceptionFromFinallyBlockRule extends AbstractAstVisitorRule {
String name = 'ThrowExceptionFromFinallyBlock'
int priority = 2
Class astVisitorClass = ThrowExceptionFromFinallyBlockAstVisitor
}
class ThrowExceptionFromFinallyBlockAstVisitor extends AbstractFinallyAstVisitor {
void visitThrowStatement(ThrowStatement throwStatement) {
if (isFirstVisit(throwStatement) && isStatementWithinFinally(throwStatement)) {
addViolation(throwStatement, 'Throwing an exception from a finally block can hide an underlying error')
}
super.visitThrowStatement(throwStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ConstantAssertExpressionRule.groovy 0000644 0001750 0001750 00000004425 12311373552 031242 0 ustar ebourg ebourg /*
* Copyright 2012 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.AssertStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for assert statements where the assert condition expressions is a constant value or literal value, such as:
*
*
assert true
*
assert false
*
assert Boolean.TRUE
*
assert Boolean.FALSE
*
assert null
*
assert 0
*
assert 99.7
*
assert ""
*
assert "abc"
*
assert [:]
*
assert [a:123, b:456]
*
assert [a, b, c]
*
*
* @author Chris Mair
*/
class ConstantAssertExpressionRule extends AbstractAstVisitorRule {
String name = 'ConstantAssertExpression'
int priority = 3
Class astVisitorClass = ConstantAssertExpressionAstVisitor
}
class ConstantAssertExpressionAstVisitor extends AbstractAstVisitor {
@Override
void visitAssertStatement(AssertStatement statement) {
if (isFirstVisit(statement)) {
def booleanExpression = statement.booleanExpression
if (AstUtil.isConstantOrLiteral(booleanExpression.expression)) {
addViolation(statement, "The assert statement within class $currentClassName has a constant boolean expression [$booleanExpression.text]")
}
}
super.visitAssertStatement(statement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/BitwiseOperatorInConditionalRule.groovy 0000644 0001750 0001750 00000006477 12006632014 032005 0 ustar ebourg ebourg /*
* Copyright 2011 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.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.ElvisOperatorExpression
import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.TernaryExpression
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codehaus.groovy.ast.stmt.WhileStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Checks for bitwise operations in conditionals, if you need to do a bitwise operation then it is best practive to extract a temp variable.
*
* @author Jeff Beck
*/
class BitwiseOperatorInConditionalRule extends AbstractAstVisitorRule {
String name = 'BitwiseOperatorInConditional'
int priority = 2
Class astVisitorClass = BitwiseOperatorInConditionalAstVisitor
}
class BitwiseOperatorInConditionalAstVisitor extends AbstractAstVisitor {
private addViolationBitwiseConditional(Expression expression) {
if (!isFirstVisit(expression)) {
return
}
def parms = [expression] as Stack
while (parms) {
def node = parms.pop()
if (node instanceof BinaryExpression) {
if (AstUtil.isBinaryExpressionType(node, '|')) {
addViolation(node, 'Use of a bitwise or (|) operator in a conditional')
} else if (AstUtil.isBinaryExpressionType(node, '&')) {
addViolation(node, 'Use of a bitwise and (&) operator in a conditional')
} else {
parms.addAll(collectChildren(node))
}
}
}
}
private collectChildren(BinaryExpression node) {
def results = []
if (node.leftExpression instanceof BinaryExpression) {
results.add(node.leftExpression)
}
if (node.rightExpression instanceof BinaryExpression) {
results.add(node.rightExpression)
}
results
}
@Override
void visitIfElse(IfStatement node) {
addViolationBitwiseConditional(node.booleanExpression.expression)
super.visitIfElse(node)
}
@Override
void visitWhileLoop(WhileStatement node) {
addViolationBitwiseConditional(node.booleanExpression.expression)
super.visitWhileLoop(node)
}
@Override
void visitTernaryExpression(TernaryExpression node) {
addViolationBitwiseConditional(node.booleanExpression.expression)
super.visitTernaryExpression(node)
}
@Override
void visitShortTernaryExpression(ElvisOperatorExpression node) {
addViolationBitwiseConditional(node.booleanExpression.expression)
super.visitShortTernaryExpression(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyMethodRule.groovy 0000644 0001750 0001750 00000003256 12052037512 026442 0 ustar ebourg ebourg /*AbstractMethodVisitor
* 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.MethodNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodVisitor
import org.codenarc.util.AstUtil
import java.lang.reflect.Modifier
/**
* A method was found without an implementation. If the method is overriding or implementing a parent method, then mark it with the @Override annotation.
*
* @author Hamlet D'Arcy
*/
class EmptyMethodRule extends AbstractAstVisitorRule {
String name = 'EmptyMethod'
int priority = 2
Class astVisitorClass = EmptyMethodAstVisitor
}
class EmptyMethodAstVisitor extends AbstractMethodVisitor {
@Override
void visitMethod(MethodNode node) {
if (AstUtil.isEmptyBlock(node.code) && !Modifier.isAbstract(node.declaringClass.modifiers)) {
if (!node.annotations.find { it?.classNode?.name == 'Override' }) {
addViolation(node, "The method $node.name is both empty and not marked with @Override")
}
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/BooleanGetBooleanRule.groovy 0000644 0001750 0001750 00000003343 12006632014 027514 0 ustar ebourg ebourg /*
* Copyright 2011 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.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
import org.codenarc.util.AstUtil
/**
* This rule catches usages of java.lang.Boolean.getBoolean(String) which reads a boolean from the System properties.
* It is often mistakenly used to attempt to read user input or parse a String into a boolean. It is a poor piece of API
* to use; replace it with System.properties['prop̈́'].
*
* @author Hamlet D'Arcy
*/
class BooleanGetBooleanRule extends AbstractAstVisitorRule {
String name = 'BooleanGetBoolean'
int priority = 2
Class astVisitorClass = BooleanGetBooleanAstVisitor
}
class BooleanGetBooleanAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (AstUtil.isMethodCall(call, 'Boolean', 'getBoolean', 1)) {
addViolation(call, 'Boolean.getBoolean(String) is a confusing API for reading System properties. Prefer the System.getProperty(String) API.')
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ComparisonWithSelfRule.groovy 0000644 0001750 0001750 00000005135 12006632014 027756 0 ustar ebourg ebourg /*
* Copyright 2011 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.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* CodeNarc Rule. Checks for using a comparison operator or equals() or compareTo() to compare a
* variable to itself, e.g.:
* x == x, x != x, x <=> x,
* x < x, x > x, x <= x, x >= x,
* x.equals(x), x.compareTo(x)
* where x is a variable
*
* @author Chris Mair
*/
class ComparisonWithSelfRule extends AbstractAstVisitorRule {
String name = 'ComparisonWithSelf'
int priority = 2
Class astVisitorClass = ComparisonWithSelfAstVisitor
}
class ComparisonWithSelfAstVisitor extends AbstractAstVisitor {
@Override
void visitBinaryExpression(BinaryExpression expression) {
if (isFirstVisit(expression) && AstUtil.isBinaryExpressionType(expression, AstUtil.COMPARISON_OPERATORS)) {
def left = expression.leftExpression
def right = expression.rightExpression
addViolationIfBothAreTheSameVariable(expression, left, right)
}
super.visitBinaryExpression(expression)
}
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (isFirstVisit(call) && (AstUtil.isMethodCall(call, 'equals', 1) || AstUtil.isMethodCall(call, 'compareTo', 1))) {
def left = call.objectExpression
def right = call.arguments.getExpression(0)
addViolationIfBothAreTheSameVariable(call, left, right)
}
super.visitMethodCallExpression(call)
}
private void addViolationIfBothAreTheSameVariable(node, left, right) {
if (left instanceof VariableExpression && right instanceof VariableExpression && left.name == right.name) {
addViolation(node, "Comparing an object to itself is useless and may indicate a bug: ${node.text}")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/ConstantIfExpressionRule.groovy 0000644 0001750 0001750 00000004245 12311373552 030337 0 ustar ebourg ebourg /*
* 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.basic
import org.codehaus.groovy.ast.stmt.IfStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for if statement with a constant value for the if expression, such as:
*
*
if (true) { .. }
*
if (false) { .. }
*
if (Boolean.TRUE) { .. }
*
if (Boolean.FALSE) { .. }
*
if (null) { .. }
*
if (0) { .. }
*
if (99.7) { .. }
*
if ("") { .. }
*
if ("abc") { .. }
*
if ([a:123, b:456]) { .. }
*
if ([a, b]) { .. }
*
*
* @author Chris Mair
*/
class ConstantIfExpressionRule extends AbstractAstVisitorRule {
String name = 'ConstantIfExpression'
int priority = 2
Class astVisitorClass = ConstantIfExpressionAstVisitor
}
class ConstantIfExpressionAstVisitor extends AbstractAstVisitor {
void visitIfElse(IfStatement ifStatement) {
if (isFirstVisit(ifStatement)) {
def booleanExpression = ifStatement.booleanExpression
if (AstUtil.isConstantOrLiteral(booleanExpression.expression)) {
addViolation(ifStatement, "The if statement condition ($booleanExpression.text) contains a constant")
}
}
super.visitIfElse(ifStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/basic/EmptyFinallyBlockRule.groovy 0000644 0001750 0001750 00000002776 12311373552 027606 0 ustar ebourg ebourg /*
* 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.TryCatchStatement
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil
/**
* Rule that checks for empty finally blocks
*
* @author Chris Mair
*/
class EmptyFinallyBlockRule extends AbstractAstVisitorRule {
String name = 'EmptyFinallyBlock'
int priority = 2
Class astVisitorClass = EmptyFinallyBlockAstVisitor
}
class EmptyFinallyBlockAstVisitor extends AbstractAstVisitor {
void visitTryCatchFinally(TryCatchStatement tryCatchStatement) {
if (isFirstVisit(tryCatchStatement) && AstUtil.isEmptyBlock(tryCatchStatement.finallyStatement)) {
addViolation(tryCatchStatement.finallyStatement, 'The finally block is empty')
}
super.visitTryCatchFinally(tryCatchStatement)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/ 0000755 0001750 0001750 00000000000 12623571301 022434 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/IllegalPackageReferenceRule.groovy 0000644 0001750 0001750 00000013361 12311370173 031201 0 ustar ebourg ebourg /*
* Copyright 2011 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.generic
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.ModuleNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.ImportUtil
import org.codenarc.util.WildcardPattern
import org.codehaus.groovy.ast.expr.*
/**
* Checks for reference to any of the named packages.
*
* The packageNames property specifies the comma-separated list of package names to check for.
* The package name(s) may optionally include wildcard characters ('*' or '?'). Note that the '*' wildcard
* matches any sequence of zero or more characters in the package name, e.g. 'a.*' matches 'a.b' as well as
* 'a.b.c.d'. If packageNames is null or empty, do nothing.
*
* Known limitation: Does not catch references as Anonymous Inner class: def x = new org.bad.Handler() { .. }
*
* @author Chris Mair
*/
class IllegalPackageReferenceRule extends AbstractAstVisitorRule {
String name = 'IllegalPackageReference'
int priority = 2
String packageNames = null
Class astVisitorClass = IllegalPackageReferenceAstVisitor
boolean isReady() {
packageNames
}
}
class IllegalPackageReferenceAstVisitor extends AbstractAstVisitor {
private wildcard
@Override
protected void visitClassEx(ClassNode node) {
wildcard = new WildcardPattern(rule.packageNames)
def superClassName = node.superClass.name
if (superClassName != 'java.lang.Object') {
checkType(superClassName, node)
}
node.interfaces.each { interfaceNode ->
checkType(interfaceNode.name, node)
}
super.visitClassEx(node)
}
@Override
void visitField(FieldNode node) {
checkTypeIfNotDynamicallyTyped(node)
}
@Override
void visitConstructorCallExpression(ConstructorCallExpression node) {
if (isFirstVisit(node) && !node.superCall) {
checkType(node.type.name, node)
}
super.visitConstructorCallExpression(node)
}
@Override
void visitVariableExpression(VariableExpression expression) {
checkTypeIfNotDynamicallyTyped(expression)
super.visitVariableExpression(expression)
}
@Override
void visitConstructorOrMethod(MethodNode node, boolean isConstructor) {
if (!node.isDynamicReturnType()) { // ignore 'def' which resolves to java.lang.Object
checkType(node.returnType.name, node)
}
node.parameters.each { parameter ->
checkTypeIfNotDynamicallyTyped(parameter)
}
super.visitConstructorOrMethod(node, isConstructor)
}
@Override
void visitClosureExpression(ClosureExpression expression) {
expression.parameters.each { parameter ->
checkTypeIfNotDynamicallyTyped(parameter)
}
super.visitClosureExpression(expression)
}
@Override
void visitCastExpression(CastExpression expression) {
checkType(expression.type.name, expression)
super.visitCastExpression(expression)
}
@Override
void visitClassExpression(ClassExpression expression) {
checkType(expression.type.name, expression)
super.visitClassExpression(expression)
}
@Override
void visitPropertyExpression(PropertyExpression expression) {
checkType(expression.text, expression)
}
@Override
void visitImports(ModuleNode node) {
def allImports = node.imports + node.starImports + node.staticImports.values() + node.staticStarImports.values()
allImports?.each { importNode ->
def parentPackage = ImportUtil.packageNameForImport(importNode)
if (wildcard.matches(parentPackage)) {
addViolation(rule.createViolationForImport(sourceCode, importNode,
"Found reference to illegal package name $parentPackage"))
}
}
super.visitImports(node)
}
//--------------------------------------------------------------------------
// Helper Methods
//--------------------------------------------------------------------------
private void checkTypeIfNotDynamicallyTyped(node) {
if (!node.isDynamicTyped()) { // ignore 'def' which resolves to java.lang.Object
checkType(node.type.name, node)
}
}
private void checkType(String typeName, node) {
def parentPackage = parentPackageName(typeName)
checkPackageName(parentPackage, node)
}
private void checkPackageName(String parentPackage, node) {
if (wildcard.matches(parentPackage)) {
addViolation(node, "Found reference to illegal package name $parentPackage")
}
}
private String parentPackageName(String typeName) {
if (typeName.contains('.')) {
def lastPeriod = typeName.lastIndexOf('.')
return typeName[0..lastPeriod - 1]
}
null
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/IllegalRegexRule.groovy 0000644 0001750 0001750 00000003377 12311373552 027113 0 ustar ebourg ebourg /*
* 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.generic
import org.codenarc.rule.AbstractRule
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
/**
* Checks for a specified illegal regular expression within the source code.
*
* The regex property specifies the regular expression to check for. If null or empty, do nothing.
*
* A RuleSet can contain any number of instances of this rule, but each should be configured
* with a unique rule name, regex, violationMessage and (optionally) customized priority.
*
* @author Chris Mair
*/
class IllegalRegexRule extends AbstractRule {
String name = 'IllegalRegex'
int priority = 3
String regex
boolean isReady() {
regex
}
void applyTo(SourceCode sourceCode, List violations) {
def matcher = sourceCode.getText() =~ regex
while (matcher.find()) {
def lineNumber = sourceCode.getLineNumberForCharacterIndex(matcher.start())
violations.add(new Violation(rule:this, lineNumber:lineNumber, sourceLine:matcher.group(),
message:"Match found for illegal regular expression \"$regex\""))
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/RequiredStringRule.groovy 0000644 0001750 0001750 00000003151 12311373552 027504 0 ustar ebourg ebourg /*
* 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.generic
import org.codenarc.rule.AbstractRule
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
/**
* Checks for a specified String that must exist within the source code.
*
* The string property specifies the String of text to check for. If null or empty, do nothing.
*
* A RuleSet can contain any number of instances of this rule, but each should be configured
* with a unique rule name, string, violationMessage and (optionally) customized priority.
*
* @author Chris Mair
*/
class RequiredStringRule extends AbstractRule {
String name = 'RequiredString'
int priority = 3
String string
boolean isReady() {
string
}
void applyTo(SourceCode sourceCode, List violations) {
if (!(sourceCode.getText().contains(string))) {
violations.add(new Violation(rule:this, message:"Match not found for required string [$string]"))
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/IllegalClassMemberRule.groovy 0000644 0001750 0001750 00000016047 12311373552 030234 0 ustar ebourg ebourg /*
* Copyright 2013 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.generic
import static org.codenarc.util.ModifiersUtil.matchesAnyModifiers
import static org.codenarc.util.ModifiersUtil.parseModifiersList
import org.codehaus.groovy.ast.AnnotationNode
import org.codehaus.groovy.ast.FieldNode
import org.codehaus.groovy.ast.MethodNode
import org.codehaus.groovy.ast.PropertyNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.WildcardPattern
/**
* Checks for classes containing fields/properties/methods matching configured illegal member modifiers.
*
* @author Chris Mair
*/
class IllegalClassMemberRule extends AbstractAstVisitorRule {
String name = 'IllegalClassMember'
int priority = 2
Class astVisitorClass = IllegalClassMemberAstVisitor
String ignoreMethodNames
String ignoreMethodsWithAnnotationNames
protected Collection illegalFieldModifiersList = []
protected String illegalFieldModifiersString
protected Collection allowedFieldModifiersList = []
protected String allowedFieldModifiersString
protected Collection illegalPropertyModifiersList = []
protected String illegalPropertyModifiersString
protected Collection allowedPropertyModifiersList = []
protected String allowedPropertyModifiersString
protected Collection illegalMethodModifiersList = []
protected String illegalMethodModifiersString
protected Collection allowedMethodModifiersList = []
protected String allowedMethodModifiersString
void setIllegalFieldModifiers(String illegalFieldModifiers) {
this.illegalFieldModifiersString = illegalFieldModifiers
this.illegalFieldModifiersList = parseModifiersList(illegalFieldModifiers)
}
void setAllowedFieldModifiers(String allowedFieldModifiers) {
this.allowedFieldModifiersString = allowedFieldModifiers
this.allowedFieldModifiersList = parseModifiersList(allowedFieldModifiers)
}
void setIllegalPropertyModifiers(String illegalPropertyModifiers) {
this.illegalPropertyModifiersString = illegalPropertyModifiers
this.illegalPropertyModifiersList = parseModifiersList(illegalPropertyModifiers)
}
void setAllowedPropertyModifiers(String allowedPropertyModifiers) {
this.allowedPropertyModifiersString = allowedPropertyModifiers
this.allowedPropertyModifiersList = parseModifiersList(allowedPropertyModifiers)
}
void setIllegalMethodModifiers(String illegalMethodModifiers) {
this.illegalMethodModifiersString = illegalMethodModifiers
this.illegalMethodModifiersList = parseModifiersList(illegalMethodModifiers)
}
void setAllowedMethodModifiers(String allowedMethodModifiers) {
this.allowedMethodModifiersString = allowedMethodModifiers
this.allowedMethodModifiersList = parseModifiersList(allowedMethodModifiers)
}
@Override
boolean isReady() {
(illegalFieldModifiersList || allowedFieldModifiersList ||
illegalMethodModifiersList || allowedMethodModifiersList ||
illegalPropertyModifiersList || allowedPropertyModifiersList) &&
(applyToClassNames || applyToFileNames || applyToFilesMatching)
}
}
class IllegalClassMemberAstVisitor extends AbstractAstVisitor {
@Override
void visitField(FieldNode node) {
boolean matchesIllegal = matchesAnyModifiers(node.modifiers, rule.illegalFieldModifiersList)
if (matchesIllegal) {
addViolation(node, "Field \"${node.name}\" has modifiers matching one of the configured illegalFieldModifiers: \"${rule.illegalFieldModifiersString}\"")
}
if (rule.allowedFieldModifiersList) {
boolean matchesAllowed = matchesAnyModifiers(node.modifiers, rule.allowedFieldModifiersList)
if (!matchesAllowed) {
addViolation(node, "Field \"${node.name}\" does not have modifiers matching one of the configured allowedFieldModifiers: \"${rule.allowedFieldModifiersString}\"")
}
}
super.visitField(node)
}
@Override
void visitProperty(PropertyNode node) {
boolean matchesIllegal = matchesAnyModifiers(node.modifiers, rule.illegalPropertyModifiersList)
if (matchesIllegal) {
addViolation(node, "Property \"${node.name}\" has modifiers matching one of the configured illegalPropertyModifiers: \"${rule.illegalPropertyModifiersString}\"")
}
if (rule.allowedPropertyModifiersList) {
boolean matchesAllowed = matchesAnyModifiers(node.modifiers, rule.allowedPropertyModifiersList)
if (!matchesAllowed) {
addViolation(node, "Property \"${node.name}\" does not have modifiers matching one of the configured allowedPropertyModifiers: \"${rule.allowedPropertyModifiersString}\"")
}
}
super.visitProperty(node)
}
@Override
protected void visitMethodEx(MethodNode node) {
boolean matchesIllegal = matchesAnyModifiers(node.modifiers, rule.illegalMethodModifiersList)
if (matchesIllegal && !matchesIgnoreMethodNames(node) && !matchesIgnoreMethodsWithAnnotationNames(node)) {
addViolation(node, "Method \"${node.name}\" has modifiers matching one of the configured illegalMethodModifiers: \"${rule.illegalMethodModifiersString}\"")
}
if (rule.allowedMethodModifiersList) {
boolean matchesAllowed = matchesAnyModifiers(node.modifiers, rule.allowedMethodModifiersList)
if (!matchesAllowed && !matchesIgnoreMethodNames(node) && !matchesIgnoreMethodsWithAnnotationNames(node)) {
addViolation(node, "Method \"${node.name}\" does not have modifiers matching one of the configured allowedMethodModifiers: \"${rule.allowedMethodModifiersString}\"")
}
}
}
private boolean matchesIgnoreMethodNames(MethodNode methodNode) {
return new WildcardPattern(rule.ignoreMethodNames, false).matches(methodNode.name)
}
private boolean matchesIgnoreMethodsWithAnnotationNames(MethodNode methodNode) {
def wildcardPattern = new WildcardPattern(rule.ignoreMethodsWithAnnotationNames, false)
List annotations = methodNode.getAnnotations()
for (AnnotationNode annotation : annotations) {
def annotationName = annotation.getClassNode().getName()
if (wildcardPattern.matches(annotationName)) {
return true
}
}
return false
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/StatelessClassRule.groovy 0000644 0001750 0001750 00000012646 12311373552 027503 0 ustar ebourg ebourg /*
* 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.generic
import static org.codenarc.util.AstUtil.hasAnnotation
import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor
import org.codenarc.util.WildcardPattern
/**
* Rule that checks for non-final fields on a class. The intent of this rule is
* to check a configured set of classes that should remain "stateless" and reentrant. One
* example might be Grails service classes, which are, by default, a singleton, and so they
* should be reentrant. DAO classes are also often kept stateless.
*
* This rule ignores final fields (either instance or static). Fields that are
* static and non-final, however, do cause a violation.
*
* This rule also ignores all classes annotated with the @Immutable transformation.
* See http://groovy.codehaus.org/Immutable+transformation.
*
* This rule also ignores fields annotated with the @Inject annotation.
*
* You can configure this rule to ignore certain fields either by name or by type. This can be
* useful to ignore fields that hold references to (static) dependencies (such as DAOs or
* Service objects) or static configuration.
*
* The ignoreFieldNames property specifies one or more (comma-separated) field names
* that should be ignored (i.e., that should not cause a rule violation). The name(s) may optionally
* include wildcard characters ('*' or '?'). You can add to the field names to be ignored by setting
* the (write-only) addIgnoreFieldNames property. This is a "special" property -- each
* call to setAddIgnoreFieldNames() adds to the existing ignoreFieldNames
* property value.
*
* The ignoreFieldTypes property specifies one or more (comma-separated) field type names
* that should be ignored (i.e., that should not cause a rule violation). The type name(s) may optionally
* include wildcard characters ('*' or '?').
*
* Note: The ignoreFieldTypes property matches the field type name as indicated
* in the field declaration, only including a full package specification IF it is included in
* the source code. For example, the field declaration BigDecimal value matches
* an ignoreFieldTypes value of BigDecimal, but not
* java.lang.BigDecimal.
*
* There is one exception for the ignoreFieldTypes property: if the field is declared
* with a modifier/type of def, then the type resolves to java.lang.Object.
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
class StatelessClassRule extends AbstractAstVisitorRule {
String name = 'StatelessClass'
int priority = 2
String ignoreFieldNames
String ignoreFieldTypes
Class astVisitorClass = StatelessClassAstVisitor
boolean isReady() {
applyToClassNames || applyToFileNames || applyToFilesMatching
}
/**
* Add more field names to the existing ignoreFieldNames property value.
* @param moreFieldNames - specifies one or more (comma-separated) field names that should be
* ignored (i.e., that should not cause a rule violation). The name(s) may optionally
* include wildcard characters ('*' or '?'). Any names specified here are joined to
* the existing ignoreFieldNames property value.
*/
void setAddToIgnoreFieldNames(String moreFieldNames) {
this.ignoreFieldNames = this.ignoreFieldNames ? this.ignoreFieldNames + ',' + moreFieldNames : moreFieldNames
}
/**
* Subclasses can optionally override to provide more specific filtering of fields
*/
protected boolean shouldIgnoreField(FieldNode fieldNode) {
return hasAnnotation(fieldNode.owner, 'Immutable') ||
hasAnnotation(fieldNode, 'Inject') ||
fieldNode.isFinal() ||
matchesIgnoreFieldNames(fieldNode) ||
matchesIgnoreFieldTypes(fieldNode)
}
private boolean matchesIgnoreFieldNames(FieldNode fieldNode) {
ignoreFieldNames && new WildcardPattern(ignoreFieldNames).matches(fieldNode.name)
}
private boolean matchesIgnoreFieldTypes(FieldNode fieldNode) {
ignoreFieldTypes && new WildcardPattern(ignoreFieldTypes).matches(fieldNode.type.name)
}
}
class StatelessClassAstVisitor extends AbstractFieldVisitor {
void visitField(FieldNode fieldNode) {
boolean ignore = rule.shouldIgnoreField(fieldNode)
if (!ignore) {
addViolation(fieldNode, "The class is marked as stateless but contains the non-final field '$fieldNode.name'")
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/RequiredRegexRule.groovy 0000644 0001750 0001750 00000003112 12311373552 027305 0 ustar ebourg ebourg /*
* 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.generic
import org.codenarc.rule.AbstractRule
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
/**
* Checks for a specified regular expression that must exist within the source code.
*
* The regex property specifies the regular expression to check for. If null or empty, do nothing.
*
* A RuleSet can contain any number of instances of this rule, but each should be configured
* with a unique rule name, regex, violationMessage and (optionally) customized priority.
*
* @author Chris Mair
*/
class RequiredRegexRule extends AbstractRule {
String name = 'RequiredRegex'
int priority = 3
String regex
boolean isReady() {
regex
}
void applyTo(SourceCode sourceCode, List violations) {
if (!(sourceCode.getText() =~ regex)) {
violations.add(new Violation(rule:this, message:"Match not found for required regular expression \"$regex\""))
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/IllegalSubclassRule.groovy 0000644 0001750 0001750 00000003162 12322755034 027611 0 ustar ebourg ebourg /*
* Copyright 2014 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.generic
import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.WildcardPattern
/**
* Checks for classes that extend one of the specified set of illegal superclasses.
*
* @author Chris Mair
*/
class IllegalSubclassRule extends AbstractAstVisitorRule {
String name = 'IllegalSubclass'
int priority = 2
Class astVisitorClass = IllegalSubclassAstVisitor
String superclassNames
boolean isReady() {
superclassNames
}
}
class IllegalSubclassAstVisitor extends AbstractAstVisitor {
@Override
protected void visitClassEx(ClassNode node) {
def wildcard = new WildcardPattern(rule.superclassNames)
def superclassName = node.superClass?.name
if (wildcard.matches(superclassName)) {
addViolation(node, "The class $node.name extends from the illegal superclass $superclassName")
}
super.visitClassEx(node)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/IllegalStringRule.groovy 0000644 0001750 0001750 00000003050 12311373552 027273 0 ustar ebourg ebourg /*
* Copyright 2013 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.generic
import org.codenarc.rule.AbstractRule
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode
/**
* Checks for a specified illegal string within the source code.
*
* The string property specifies the String of text to check for. If null or empty, do nothing.
*
* A RuleSet can contain any number of instances of this rule, but each should be configured
* with a unique rule name, string, violationMessage and (optionally) customized priority.
*
* @author Chris Mair
*/
class IllegalStringRule extends AbstractRule {
String name = 'IllegalString'
int priority = 2
String string
boolean isReady() {
string
}
void applyTo(SourceCode sourceCode, List violations) {
if (sourceCode.getText().contains(string)) {
violations.add(new Violation(rule:this, message:"Match found for illegal string [$string]"))
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/rule/generic/IllegalClassReferenceRule.groovy 0000644 0001750 0001750 00000003336 12006632012 030706 0 ustar ebourg ebourg /*
* Copyright 2011 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.generic
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AstVisitor
import org.codenarc.rule.ClassReferenceAstVisitor
/**
* Checks for reference to any of the named classes.
*
* The classNames property specifies the comma-separated list of (fully-qualified) class names to check for.
* The class name(s) may optionally include wildcard characters ('*' or '?'). Note that the '*' wildcard
* matches any sequence of zero or more characters in the class/package name, e.g. 'a.*.MyClass' matches
* 'a.b.MyClass' as well as 'a.b.c.d.MyClass'. If classNames is null or empty, do nothing.
*
* Known limitation: Does not catch references as Anonymous Inner class: def x = new org.bad.Handler() { .. }
*
* @author Chris Mair
*/
class IllegalClassReferenceRule extends AbstractAstVisitorRule {
String name = 'IllegalClassReference'
int priority = 2
String classNames = null
@Override
AstVisitor getAstVisitor() {
new ClassReferenceAstVisitor(classNames)
}
@Override
boolean isReady() {
classNames
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/report/ 0000755 0001750 0001750 00000000000 12623571301 021364 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/report/AbstractReportWriter.groovy 0000644 0001750 0001750 00000014301 12311373554 026772 0 ustar ebourg ebourg /*
* 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.report
import groovy.text.SimpleTemplateEngine
import org.apache.log4j.Logger
import org.codenarc.AnalysisContext
import org.codenarc.results.Results
import org.codenarc.rule.Rule
import org.codenarc.util.AstUtil
import org.codenarc.util.io.ClassPathResource
/**
* Abstract superclass for ReportWriter implementation classes.
*
* Subclasses must implement the writeReport(ResultsNode, MetricSet, Writer) method
* and define a defaultOutputFile property.
*
* @author Chris Mair
*/
abstract class AbstractReportWriter implements ReportWriter {
protected static final BASE_MESSAGES_BUNDLE = 'codenarc-base-messages'
protected static final CUSTOM_MESSAGES_BUNDLE = 'codenarc-messages'
protected static final VERSION_FILE = 'codenarc-version.txt'
protected static final CODENARC_URL = 'http://www.codenarc.org'
String outputFile
Object writeToStandardOut
private static final LOG = Logger.getLogger(AbstractReportWriter)
protected getTimestamp = { new Date() }
protected customMessagesBundleName = CUSTOM_MESSAGES_BUNDLE
protected resourceBundle
private final templateEngine = new SimpleTemplateEngine()
// Allow tests to override this
protected initializeResourceBundle = { initializeDefaultResourceBundle() }
abstract void writeReport(Writer writer, AnalysisContext analysisContext, Results results)
/**
* Write out a report for the specified analysis results
* @param analysisContext - the AnalysisContext containing the analysis configuration information
* @param results - the analysis results
*/
void writeReport(AnalysisContext analysisContext, Results results) {
assert analysisContext
assert results
if (isWriteToStandardOut()) {
writeReportToStandardOut(analysisContext, results)
}
else {
writeReportToFile(analysisContext, results)
}
}
private void writeReportToStandardOut(AnalysisContext analysisContext, Results results) {
def writer = new OutputStreamWriter(System.out)
writeReport(writer, analysisContext, results)
}
private void writeReportToFile(AnalysisContext analysisContext, Results results) {
def outputFilename = outputFile ?: getProperty('defaultOutputFile')
def outputFile = new File(outputFilename)
outputFile.getParentFile()?.mkdirs()
outputFile.withWriter { writer ->
writeReport(writer, analysisContext, results)
}
LOG.info("Report file [$outputFilename] created.")
}
protected void initializeDefaultResourceBundle() {
def baseBundle = ResourceBundle.getBundle(BASE_MESSAGES_BUNDLE)
resourceBundle = baseBundle
try {
resourceBundle = ResourceBundle.getBundle(customMessagesBundleName)
LOG.info("Using custom message bundle [$customMessagesBundleName]")
resourceBundle.setParent(baseBundle)
}
catch(MissingResourceException) {
LOG.info("No custom message bundle found for [$customMessagesBundleName]. Using default messages.")
}
}
protected String getHtmlDescriptionForRule(Rule rule) {
def rawMessageText = getDescriptionProperty(rule) ?: getHtmlRuleDescription(rule) ?: getRuleDescriptionOrDefaultMessage(rule)
return substituteMessageParametersIfPresent(rule, rawMessageText)
}
protected String getDescriptionForRule(Rule rule) {
def rawMessageText = getDescriptionProperty(rule) ?: getRuleDescriptionOrDefaultMessage(rule)
return substituteMessageParametersIfPresent(rule, rawMessageText)
}
private String substituteMessageParametersIfPresent(Rule rule, String rawMessageText) {
if (rawMessageText.contains('${')) {
def template = templateEngine.createTemplate(rawMessageText)
def binding = [rule:rule]
return template.make(binding)
}
rawMessageText
}
private String getHtmlRuleDescription(Rule rule) {
def resourceKey = rule.name + '.description.html'
getResourceBundleString(resourceKey, null, false)
}
private String getRuleDescriptionOrDefaultMessage(Rule rule) {
def resourceKey = rule.name + '.description'
getResourceBundleString(resourceKey, "No description provided for rule named [$rule.name]")
}
private String getDescriptionProperty(Rule rule) {
AstUtil.respondsTo(rule, 'getDescription') ? rule.description : null
}
protected String getResourceBundleString(String resourceKey, String defaultString='?', boolean logWarning=true) {
def string = defaultString
try {
string = resourceBundle.getString(resourceKey)
} catch (MissingResourceException e) {
if (logWarning) {
LOG.warn("No string found for resourceKey=[$resourceKey]")
}
}
string
}
protected String getFormattedTimestamp() {
def dateFormat = java.text.DateFormat.getDateTimeInstance()
dateFormat.format(getTimestamp())
}
protected List getSortedRules(AnalysisContext analysisContext) {
def rules = analysisContext.ruleSet.rules.findAll { rule -> isEnabled(rule) }
rules.toList().sort { rule -> rule.name }
}
protected boolean isEnabled(Rule rule) {
(!AstUtil.respondsTo(rule, 'isEnabled') || rule.enabled)
}
protected String getCodeNarcVersion() {
ClassPathResource.getInputStream(VERSION_FILE).text
}
private boolean isWriteToStandardOut() {
writeToStandardOut == true || writeToStandardOut == 'true'
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/report/XmlReportWriter.groovy 0000644 0001750 0001750 00000013215 12451074641 025772 0 ustar ebourg ebourg /*
* 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.report
import groovy.xml.StreamingMarkupBuilder
import org.codenarc.AnalysisContext
import org.codenarc.results.FileResults
import org.codenarc.results.Results
import org.codenarc.rule.Violation
import org.codenarc.util.PathUtil
/**
* ReportWriter that generates an XML report.
*
* @author Chris Mair
*/
@SuppressWarnings(['UnnecessaryReturnKeyword', 'FactoryMethodName'])
class XmlReportWriter extends AbstractReportWriter {
String title
String defaultOutputFile = 'CodeNarcXmlReport.xml'
void writeReport(Writer writer, AnalysisContext analysisContext, Results results) {
assert analysisContext
assert results
initializeResourceBundle()
def builder = new StreamingMarkupBuilder()
def xml = builder.bind {
mkp.xmlDeclaration()
CodeNarc(url:CODENARC_URL, version:getCodeNarcVersion()) {
out << buildReportElement()
out << buildProjectElement(analysisContext)
out << buildPackageElements(results)
out << buildRulesElement(analysisContext)
}
}
writer << xml
}
//--------------------------------------------------------------------------
// Internal Helper Methods
//--------------------------------------------------------------------------
protected buildReportElement() {
return {
Report(timestamp:getFormattedTimestamp())
}
}
protected buildProjectElement(AnalysisContext analysisContext) {
return {
Project(title:title) {
analysisContext.sourceDirectories.each { sourceDirectory ->
SourceDirectory(sourceDirectory)
}
}
}
}
protected buildPackageElements(results) {
return buildPackageElement(results)
}
protected buildPackageElement(results) {
def elementName = isRoot(results) ? 'PackageSummary' : 'Package'
return {
"$elementName"(buildPackageAttributeMap(results)) {
results.children.each { child ->
if (child.isFile()) {
out << buildFileElement(child)
}
}
}
results.children.each { child ->
if (!child.isFile()) {
out << buildPackageElement(child)
}
}
}
}
protected Map buildPackageAttributeMap(results) {
def attributeMap = [
totalFiles: results.getTotalNumberOfFiles(),
filesWithViolations: results.getNumberOfFilesWithViolations(3),
priority1:results.getNumberOfViolationsWithPriority(1),
priority2:results.getNumberOfViolationsWithPriority(2),
priority3:results.getNumberOfViolationsWithPriority(3)
]
if (!isRoot(results)) {
attributeMap = [path:results.path] + attributeMap
}
return attributeMap
}
protected boolean isRoot(results) {
results.path == null
}
protected buildFileElement(FileResults results) {
return {
def name = PathUtil.getName(results.path)
File(name: name) {
results.violations.each { violation ->
out << buildViolationElement(violation)
}
}
}
}
protected buildViolationElement(Violation violation) {
def rule = violation.rule
return {
Violation(ruleName:rule.name, priority:rule.priority, lineNumber:violation.lineNumber) {
out << buildSourceLineElement(violation)
out << buildMessageElement(violation)
}
}
}
protected buildSourceLineElement(Violation violation) {
return (violation.sourceLine) ? { SourceLine(cdata(removeIllegalCharacters(violation.sourceLine))) } : null
}
protected buildMessageElement(Violation violation) {
return (violation.message) ? { Message(cdata(removeIllegalCharacters(violation.message))) } : null
}
protected buildRulesElement(AnalysisContext analysisContext) {
def sortedRules = getSortedRules(analysisContext)
return {
Rules {
sortedRules.each { rule ->
def description = this.getDescriptionForRule(rule)
Rule(name:rule.name) {
Description(cdata(description))
}
}
}
}
}
protected cdata(String text) {
return {
unescaped << ''
}
}
protected String removeIllegalCharacters(String string) {
// See http://www.w3.org/TR/xml/#charsets
// See http://stackoverflow.com/questions/730133/invalid-characters-in-xml
// #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
final REGEX = /[^\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]/
return string.replaceAll(REGEX, '')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/report/IdeTextReportWriter.groovy 0000644 0001750 0001750 00000002745 12445626230 026606 0 ustar ebourg ebourg /*
* Copyright 2014 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.report
import org.codenarc.rule.Violation
import org.codenarc.util.PathUtil
/**
* ReportWriter that generates an simple ASCII text report, and includes IDE-compatible
* (Eclipse, Idea) hyperlinks to source code for violations.
*
* Set the maxPriority property to control the maximum priority level for violations in
* the report. For instance, setting maxPriority to 2 will result in the report containing
* only priority 1 and 2 violations (and omitting violations with priority 3). The
* maxPriority property defaults to 3.
*
* @author Chris Mair
*/
class IdeTextReportWriter extends TextReportWriter {
@Override
protected String getViolationLocationString(Violation violation, String path) {
def fileName = PathUtil.getName(path)
return "Loc=.($fileName:${violation.lineNumber})"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/report/ReportWriter.groovy 0000644 0001750 0001750 00000002235 12311373552 025307 0 ustar ebourg ebourg /*
* 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.report
import org.codenarc.AnalysisContext
import org.codenarc.results.Results
/**
* Represents the interface of an object that can write out a report
*
* @author Chris Mair
*/
interface ReportWriter {
/**
* Write out a report for the specified analysis results
* @param analysisContext - the AnalysisContext containing the analysis configuration information
* @param results - the analysis results
*/
void writeReport(AnalysisContext analysisContext, Results results)
}
CodeNarc-0.23/src/main/groovy/org/codenarc/report/TextReportWriter.groovy 0000644 0001750 0001750 00000010015 12405332375 026151 0 ustar ebourg ebourg /*
* 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.report
import org.codenarc.AnalysisContext
import org.codenarc.results.FileResults
import org.codenarc.results.Results
import org.codenarc.rule.Violation
/**
* ReportWriter that generates an simple ASCII text report.
*
* Set the maxPriority property to control the maximum priority level for violations in
* the report. For instance, setting maxPriority to 2 will result in the report containing
* only priority 1 and 2 violations (and omitting violations with priority 3). The
* maxPriority property defaults to 3.
*
* @author Chris Mair
*/
class TextReportWriter extends AbstractReportWriter {
String title
String defaultOutputFile = 'CodeNarcReport.txt'
int maxPriority = 3
@Override
void writeReport(Writer writer, AnalysisContext analysisContext, Results results) {
initializeResourceBundle()
def printWriter = new PrintWriter(writer)
writeTitle(printWriter)
writeSummary(printWriter, results)
writePackageViolations(printWriter, results)
writeFooter(printWriter)
printWriter.flush()
}
protected void writeTitle(Writer writer) {
def titleString = 'CodeNarc Report' + (title ? ': ' + title : '') + ' - ' + getFormattedTimestamp()
writer.println(titleString)
}
protected void writeSummary(Writer writer, Results results) {
def summary = "Summary: TotalFiles=${results.totalNumberOfFiles} " +
"FilesWithViolations=${results.getNumberOfFilesWithViolations(maxPriority)}"
(1..maxPriority).each { p ->
summary += " P$p=${results.getNumberOfViolationsWithPriority(p)}"
}
writer.println()
writer.println(summary)
}
protected void writePackageViolations(Writer writer, Results results) {
results.children.each { child ->
if (child.isFile()) {
writeFileViolations(writer, child)
}
else {
writePackageViolations(writer, child)
}
}
}
protected void writeFileViolations(Writer writer, FileResults results) {
if (results.violations.find { v -> v.rule.priority <= maxPriority }) {
writer.println()
writer.println('File: ' + results.path)
def violations = results.violations.findAll { v -> v.rule.priority <= maxPriority }
violations.sort { violation -> violation.rule.priority }.each { violation ->
writeViolation(writer, violation, results.path)
}
}
}
protected void writeViolation(Writer writer, Violation violation, String path) {
def rule = violation.rule
def locationString = getViolationLocationString(violation, path)
def message = violation.message ? " Msg=[${violation.message}]" : ''
def sourceLine = violation.sourceLine ? " Src=[${violation.sourceLine}]" : ''
writer.println " Violation: Rule=${rule.name} P=${rule.priority} ${locationString}$message$sourceLine"
}
@SuppressWarnings('UnusedMethodParameter')
protected String getViolationLocationString(Violation violation, String path) {
return "Line=${violation.lineNumber}"
}
protected void writeFooter(Writer writer) {
writer.println()
writer.println("[CodeNarc ($CODENARC_URL) v" + getCodeNarcVersion() + ']')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/report/HtmlReportWriter.groovy 0000644 0001750 0001750 00000034702 12450013112 026123 0 ustar ebourg ebourg /*
* Copyright 2014 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.report
import groovy.xml.StreamingMarkupBuilder
import org.codenarc.AnalysisContext
import org.codenarc.results.Results
import org.codenarc.rule.Rule
import org.codenarc.rule.Violation
import org.codenarc.util.io.ClassPathResource
/**
* ReportWriter that generates an HTML report.
*
* The default localized messages, including rule descriptions, are read from the "codenarc-base-messages"
* ResourceBundle. You can override these messages using the normal ResourceBundle mechanisms (i.e.
* creating a locale-specific resource bundle file on the classpath, such as "codenarc-base-messages_de").
* You can optionally add rule descriptions for custom rules by placing them within a "codenarc-messages.properties"
* file on the classpath, with entries of the form: {rule-name}.description=..."
*
* Set the includeSummaryByPackage property to false to exclude the violation summary for each package
* within the "Summary" section of the report. It defaults to true.
*
* Set the maxPriority property to control the maximum priority level for violations in
* the report. For instance, setting maxPriority to 2 will result in the report containing
* only priority 1 and 2 violations (and omitting violations with priority 3). The
* maxPriority property defaults to 3.
*
* @author Chris Mair
*/
@SuppressWarnings(['DuplicateMapLiteral', 'UnnecessaryReturnKeyword', 'FactoryMethodName'])
class HtmlReportWriter extends AbstractReportWriter {
public static final DEFAULT_OUTPUT_FILE = 'CodeNarcReport.html'
private static final CSS_FILE = 'codenarc-htmlreport.css'
private static final ROOT_PACKAGE_NAME = ''
private static final MAX_SOURCE_LINE_LENGTH = 70
private static final SOURCE_LINE_LAST_SEGMENT_LENGTH = 12
String title
String defaultOutputFile = DEFAULT_OUTPUT_FILE
boolean includeSummaryByPackage = true
int maxPriority = 3
/**
* Write out a report to the specified Writer for the analysis results
* @param analysisContext - the AnalysisContext containing the analysis configuration information
* @param results - the analysis results
*/
void writeReport(Writer writer, AnalysisContext analysisContext, Results results) {
assert analysisContext
assert results
initializeResourceBundle()
def builder = new StreamingMarkupBuilder()
def html = builder.bind {
html {
out << buildHeaderSection()
out << buildBodySection(analysisContext, results)
}
}
writer << html
}
String toString() {
"HtmlReportWriter[outputFile=$outputFile, title=$title]"
}
//--------------------------------------------------------------------------
// Internal Helper Methods
//--------------------------------------------------------------------------
private buildCSS() {
return {
def cssInputStream = ClassPathResource.getInputStream(CSS_FILE)
assert cssInputStream, "CSS File [$CSS_FILE] not found"
def css = cssInputStream.text
style(type: 'text/css') {
unescaped << css
}
}
}
private buildHeaderSection() {
return {
head {
title(buildTitle())
out << buildCSS()
}
}
}
private buildBodySection(AnalysisContext analysisContext, results) {
return {
body {
// TODO: copy the image or inline it in the css
out << buildLogo()
h1(getResourceBundleString('htmlReport.titlePrefix'))
out << buildReportMetadata()
out << buildSummaryByPackage(results)
out << buildAllPackageSections(results)
out << buildRuleDescriptions(analysisContext)
}
}
}
private buildReportMetadata() {
return {
div(class: 'metadata') {
table {
tr {
td(class: 'em', getResourceBundleString('htmlReport.reportTitle.title'))
td title
}
tr {
td(class: 'em', getResourceBundleString('htmlReport.reportTimestamp.label'))
td getFormattedTimestamp()
}
tr {
td(class: 'em', getResourceBundleString('htmlReport.reportVersion.label'))
td { a("CodeNarc v${getCodeNarcVersion()}", href:CODENARC_URL) }
}
}
}
}
}
private buildLogo() {
return {
img(class: 'logo', src: 'http://codenarc.sourceforge.net/images/codenarc-logo.png', alt: 'CodeNarc', align: 'right')
}
}
private buildSummaryByPackage(results) {
return {
div(class: 'summary') {
h2(getResourceBundleString('htmlReport.summary.title'))
table {
tr(class:'tableHeader') {
th(getResourceBundleString('htmlReport.summary.packageHeading'))
th(getResourceBundleString('htmlReport.summary.totalFilesHeading'))
th(getResourceBundleString('htmlReport.summary.filesWithViolationsHeading'))
(1..maxPriority).each { p ->
th(getResourceBundleString("htmlReport.summary.priority${p}Heading"))
}
}
out << buildSummaryByPackageRow(results, true)
if (includeSummaryByPackage) {
out << buildAllSummaryByPackageRowsRecursively(results)
}
}
}
}
}
private buildAllSummaryByPackageRowsRecursively(results) {
return {
results.children.each { child ->
if (isDirectoryContainingFiles(child)) {
out << buildSummaryByPackageRow(child, false)
}
if (!child.isFile()) {
out << buildAllSummaryByPackageRowsRecursively(child)
}
}
}
}
private buildSummaryByPackageRow(results, boolean allPackages) {
def recursive = allPackages
return {
tr {
if (allPackages) {
td(getResourceBundleString('htmlReport.summary.allPackages'), class:'allPackages')
}
else {
def pathName = results.path ?: ROOT_PACKAGE_NAME
if (isDirectoryContainingFilesWithViolations(results)) {
td {
a(pathName, href:"#${pathName}")
}
}
else {
td(pathName)
}
}
td(results.getTotalNumberOfFiles(recursive), class:'number')
td(results.getNumberOfFilesWithViolations(maxPriority, recursive) ?: '-', class:'number')
(1..maxPriority).each { p ->
td(results.getNumberOfViolationsWithPriority(p, recursive) ?: '-', class:'priority' + p)
}
}
}
}
private buildAllPackageSections(results) {
return {
results.children.each { child ->
out << buildPackageSection(child)
}
}
}
private buildPackageSection(results) {
return {
def pathName = results.path ?: ROOT_PACKAGE_NAME
if (isDirectoryContainingFilesWithViolations(results)) {
div(class: 'summary') {
a(' ', name: pathName)
h2("Package: ${pathName.replaceAll('/', '.')}", class:'packageHeader')
}
}
results.children.each { child ->
if (child.isFile() && child.violations.find { v -> v.rule.priority <= maxPriority }) {
div(class: 'summary') {
h3(class:'fileHeader') {
mkp.yieldUnescaped '➥ ' + (child.path - "$pathName/")
}
out << buildFileSection(child)
}
}
else {
out << buildPackageSection(child)
}
}
}
}
private buildFileSection(results) {
assert results.isFile()
return {
table(border:'1') {
tr(class:'tableHeader') {
th(getResourceBundleString('htmlReport.violations.ruleName'))
th(getResourceBundleString('htmlReport.violations.priority'))
th(getResourceBundleString('htmlReport.violations.lineNumber'))
th(getResourceBundleString('htmlReport.violations.sourceLine'))
}
def violations = results.violations.findAll { v -> v.rule.priority <= maxPriority }
// def violations = results.violations
violations.sort { v -> v.rule.priority }
violations.each { Violation violation ->
def moreInfo = violation.message ? violation.message : ''
tr {
td {
a(violation.rule.name, href:"#${violation.rule.name}")
}
td(class: "priority${violation.rule.priority}", violation.rule.priority)
td(violation.lineNumber, class:'number')
td {
if (violation.sourceLine) {
def formattedSourceLine = formatSourceLine(violation.sourceLine)
p(class:'violationInfo') {
span('[SRC]', class:'violationInfoPrefix')
span(formattedSourceLine, class:'sourceCode')
}
}
if (moreInfo) {
p(class:'violationInfo') {
span('[MSG]', class:'violationInfoPrefix')
span(moreInfo, class:'violationMessage')
}
}
}
}
}
}
}
}
private buildRuleDescriptions(AnalysisContext analysisContext) {
def sortedRules = getSortedRules(analysisContext)
return {
div(class: 'summary') {
h2(getResourceBundleString('htmlReport.ruleDescriptions.title'))
table(border:'1') {
tr(class:'tableHeader') {
th('#', class:'ruleDescriptions')
th(getResourceBundleString('htmlReport.ruleDescriptions.ruleNameHeading'), class:'ruleDescriptions')
th(getResourceBundleString('htmlReport.ruleDescriptions.descriptionHeading'), class:'ruleDescriptions')
}
sortedRules.eachWithIndex { Rule rule, index ->
def ruleName = rule.name
def priority = rule.priority
tr(class:'ruleDescriptions') {
td {
a(name:ruleName) { }
span(index + 1,class:'ruleIndex')
}
td(ruleName, class:"ruleName priority${priority}")
td { unescaped << getHtmlDescriptionForRule(rule) }
}
}
}
}
}
}
/**
* Format and trim the source line. If the whole line fits, then include the whole line (trimmed).
* Otherwise, remove characters from the middle to truncate to the max length.
* @param sourceLine - the source line to format
* @param startColumn - the starting column index; used to truncate the line if it's too long; defaults to 0
* @return the formatted and trimmed source line
*/
protected String formatSourceLine(String sourceLine, int startColumn=0) {
def source = sourceLine ? sourceLine.trim() : null
if (source && source.size() > MAX_SOURCE_LINE_LENGTH) {
source = startColumn ? sourceLine[startColumn..-1] : sourceLine.trim()
def lengthOfFirstSegment = MAX_SOURCE_LINE_LENGTH - SOURCE_LINE_LAST_SEGMENT_LENGTH - 2
def firstSegment = source[0..lengthOfFirstSegment - 1]
def lastSegment = source[-SOURCE_LINE_LAST_SEGMENT_LENGTH..-1]
source = firstSegment + '..' + lastSegment
}
return source
}
/**
* Return true if the Results represents a directory that contains at least one file with one
* or more violations.
* @param results - the Results
*/
protected boolean isDirectoryContainingFilesWithViolations(Results results) {
return !results.isFile() && results.getNumberOfFilesWithViolations(maxPriority, false)
}
/**
* Return true if the Results represents a directory that contains at least one file
* @param results - the Results
*/
protected boolean isDirectoryContainingFiles(Results results) {
return !results.isFile() && results.getTotalNumberOfFiles(false)
}
private String buildTitle() {
getResourceBundleString('htmlReport.titlePrefix') + (title ? ": $title" : '')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/report/InlineXmlReportWriter.groovy 0000644 0001750 0001750 00000003634 12311370173 027127 0 ustar ebourg ebourg /*
* 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.report
import org.codenarc.AnalysisContext
import org.codenarc.rule.Violation
/**
* ReportWriter that generates an XML report with inline rule descriptions.
* This makes it easy for Hudson to parse
*
* @author Robin Bramley
*/
@SuppressWarnings('UnnecessaryReturnKeyword')
class InlineXmlReportWriter extends XmlReportWriter {
//--------------------------------------------------------------------------
// Internal Helper Methods
//--------------------------------------------------------------------------
@Override
protected buildViolationElement(Violation violation) {
def rule = violation.rule
return {
Violation(ruleName:rule.name, priority:rule.priority, lineNumber:violation.lineNumber) {
out << buildSourceLineElement(violation)
out << buildMessageElement(violation)
out << buildDescriptionElement(rule) // put inline
}
}
}
@Override
protected buildRulesElement(AnalysisContext analysisContext) {
// No-op as we have inline rule descriptions
}
@SuppressWarnings('FactoryMethodName')
private buildDescriptionElement(rule) {
def description = this.getDescriptionForRule(rule)
return { Description(cdata(description)) }
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/report/ReportWriterFactory.groovy 0000644 0001750 0001750 00000004036 12415111506 026632 0 ustar ebourg ebourg /*
* 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.report
import org.codenarc.util.PropertyUtil
/**
* Factory for ReportWriter objects based on the report type (name).
*
* The passed in type can either be one of the predefined type names: "html", "xml", "console",
* "ide", "inlineXml", or else it can specify the fully-qualified class name of a class (accessible on the
* classpath) that implements the org.codenarc.report.ReportWriter interface.
*
* @author Chris Mair
*/
class ReportWriterFactory {
ReportWriter getReportWriter(String type) {
assert type
switch(type) {
case 'html': return new HtmlReportWriter()
case 'xml': return new XmlReportWriter()
case 'text': return new TextReportWriter()
case 'console': def w = new TextReportWriter(); w.writeToStandardOut = true; return w
case 'ide': def w = new IdeTextReportWriter(); w.writeToStandardOut = true; return w
case 'inlineXml' : return new InlineXmlReportWriter()
}
def reportClass = getClass().classLoader.loadClass(type)
reportClass.newInstance()
}
ReportWriter getReportWriter(String type, Map options) {
def reportWriter = getReportWriter(type)
options.each { name, value ->
PropertyUtil.setPropertyFromString(reportWriter, name, value)
}
reportWriter
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/tool/ 0000755 0001750 0001750 00000000000 12623571301 021026 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/tool/GenerateCodeNarcRulesProperties.groovy 0000644 0001750 0001750 00000003750 12311370173 030521 0 ustar ebourg ebourg /*
* Copyright 2011 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.tool
import org.apache.log4j.Logger
import org.codenarc.ruleregistry.PropertiesFileRuleRegistry
/**
* Java application (main() method) that generates the 'codenarc-base-rules.properties' properties file.
* This properties file contains = properties for all CodeNarc rules.
*
* @see org.codenarc.ruleregistry.PropertiesFileRuleRegistry
*
* @author Chris Mair
*/
class GenerateCodeNarcRulesProperties {
protected static final PROPERTIES_FILE = PropertiesFileRuleRegistry.PROPERTIES_FILE
private static final LOG = Logger.getLogger(GenerateCodeNarcRulesProperties)
protected static propertiesFile = PROPERTIES_FILE
/**
* Write out all current rules to the 'codenarc-base-rules.properties' properties file
* @param args - command-line args (not used)
*/
static void main(String[] args) {
def sortedRules = GenerateUtil.createSortedListOfAllRules()
LOG.debug("sortedRules=$sortedRules")
def propertiesFile = new File(propertiesFile)
propertiesFile.withWriter { writer ->
writer.println '# CodeNarc Rules (see PropertiesFileRuleRegistry): ' + new Date()
sortedRules.each { rule ->
writer.println "${rule.name} = ${rule.class.name}"
}
}
LOG.info("Finished writing ${sortedRules.size()} rules to $propertiesFile")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/tool/GenerateAll.groovy 0000644 0001750 0001750 00000002326 12311370173 024461 0 ustar ebourg ebourg /*
* Copyright 2011 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.tool
import org.apache.log4j.BasicConfigurator
/**
* Java application (main() method) that invokes all of the Generate* scripts.
*
* @author Chris Mair
*/
class GenerateAll {
/**
* Invoke all generation scripts
* @param args - command-line args (not used)
*/
static void main(String[] args) {
BasicConfigurator.configure()
GenerateCodeNarcRulesProperties.main(null)
GenerateRuleSetAllRules.main(null)
GenerateRuleSetAllRulesByCategory.main(null)
GenerateRuleIndexPage.main(null)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/tool/GenerateUtil.groovy 0000644 0001750 0001750 00000003553 12166016544 024700 0 ustar ebourg ebourg /*
* Copyright 2011 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.tool
import org.codenarc.ruleset.CompositeRuleSet
import org.codenarc.ruleset.RuleSets
import org.codenarc.ruleset.XmlFileRuleSet
import org.codenarc.util.io.ClassPathResource
/**
* Contains static utility methods related to the Generate* tools.
*
* @author Chris Mair
*/
class GenerateUtil {
private static final RULE_EXTRA_INFO_FILE = 'codenarc-rule-extrainfo.properties'
private static Properties ruleExtraInformation
static Properties getRuleExtraInformation() {
if (ruleExtraInformation) {
return ruleExtraInformation
}
ruleExtraInformation = new Properties()
ruleExtraInformation.load(ClassPathResource.getInputStream(RULE_EXTRA_INFO_FILE))
ruleExtraInformation
}
static List createSortedListOfAllRules() {
def allRuleSet = new CompositeRuleSet()
RuleSets.ALL_RULESET_FILES.each { ruleSetPath ->
def ruleSet = new XmlFileRuleSet(ruleSetPath)
allRuleSet.addRuleSet(ruleSet)
}
sortRules(allRuleSet.rules)
}
static List sortRules(List rules) {
def allRules = []
allRules.addAll(rules)
allRules.sort { rule -> rule.name }
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/tool/GenerateRuleSetAllRulesByCategory.groovy 0000644 0001750 0001750 00000004755 12311370173 031001 0 ustar ebourg ebourg /*
* Copyright 2011 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.tool
import groovy.text.SimpleTemplateEngine
import org.apache.log4j.Logger
import org.codenarc.ruleset.RuleSets
import org.codenarc.ruleset.XmlFileRuleSet
/**
* Java application (main() method) that generates the "StarterRuleSet-AllRulesByCategory.groovy.txt.template" file.
* This file is a valid CodeNarc ruleset file that includes ALL rules distributed with CodeNarc, grouped by the
* category.
*
* @author Chris Mair
*/
class GenerateRuleSetAllRulesByCategory {
protected static final RULESET_FILE = 'src/site/resources/StarterRuleSet-AllRulesByCategory.groovy.txt'
private static final TEMPLATE_FILE = 'src/main/resources/templates/StarterRuleSet-AllRulesByCategory.groovy.template'
private static final LOG = Logger.getLogger(GenerateRuleSetAllRulesByCategory)
protected static ruleSetFile = RULESET_FILE
/**
* Write out all current rules to the 'codenarc-base-rules.properties' properties file
* @param args - command-line args (not used)
*/
static void main(String[] args) {
def rulesByRuleSet = [:]
RuleSets.ALL_RULESET_FILES.each { ruleSetPath ->
def ruleSet = new XmlFileRuleSet(ruleSetPath)
rulesByRuleSet[ruleSetPath] = GenerateUtil.sortRules(ruleSet.rules)
}
LOG.info("rulesByCategory=$rulesByRuleSet")
Properties ruleExtraInformation = GenerateUtil.getRuleExtraInformation()
def binding = [ruleSets:rulesByRuleSet, ruleExtraInformation:ruleExtraInformation]
def ruleSetTemplateFile = new File(TEMPLATE_FILE)
def engine = new SimpleTemplateEngine()
def ruleSetText = engine.createTemplate(ruleSetTemplateFile).make(binding)
def outputFile = new File(ruleSetFile)
outputFile.text = ruleSetText
LOG.info("Finished writing $ruleSetFile")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/tool/GenerateRuleIndexPage.groovy 0000644 0001750 0001750 00000004751 12311370173 026451 0 ustar ebourg ebourg /*
* Copyright 2011 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.tool
import groovy.text.SimpleTemplateEngine
import org.apache.log4j.Logger
import org.codenarc.ruleset.RuleSets
import org.codenarc.ruleset.XmlFileRuleSet
/**
* Java application (main() method) that generates the "codenarc-rule-index.apt.template" file.
* which is the APT file for the Rule Index page of the project web site.
*
* @author Chris Mair
*/
class GenerateRuleIndexPage {
protected static final RULE_INDEX_FILE = 'src/site/apt/codenarc-rule-index.apt'
private static final TEMPLATE_FILE = 'src/main/resources/templates/codenarc-rule-index.apt.template'
private static final LOG = Logger.getLogger(GenerateRuleIndexPage)
protected static ruleIndexFile = RULE_INDEX_FILE
/**
* Write out all current rule index to the 'codenarc-rule-index.apt' APT file
* @param args - command-line args (not used)
*/
static void main(String[] args) {
def rulesByRuleSet = [:]
def numberOfRules = 0
RuleSets.ALL_RULESET_FILES.each { ruleSetPath ->
def ruleSet = new XmlFileRuleSet(ruleSetPath)
def ruleSetName = ruleSetPath - 'rulesets/' - '.xml'
rulesByRuleSet[ruleSetName] = GenerateUtil.sortRules(ruleSet.rules)
numberOfRules += rulesByRuleSet[ruleSetName].size()
}
Properties ruleExtraInformation = GenerateUtil.getRuleExtraInformation()
def binding = [ruleSets:rulesByRuleSet, numberOfRules:numberOfRules, ruleExtraInformation:ruleExtraInformation]
def ruleSetTemplateFile = new File(TEMPLATE_FILE)
def engine = new SimpleTemplateEngine()
def ruleSetText = engine.createTemplate(ruleSetTemplateFile).make(binding)
def outputFile = new File(ruleIndexFile)
outputFile.text = ruleSetText
LOG.info("Finished writing $ruleIndexFile")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/tool/GenerateRuleSetAllRules.groovy 0000644 0001750 0001750 00000004255 12311370173 027003 0 ustar ebourg ebourg /*
* Copyright 2011 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.tool
import groovy.text.SimpleTemplateEngine
import org.apache.log4j.Logger
/**
* Java application (main() method) that generates the "StarterRuleSet-AllRules.groovy.txt.template" file.
* This file is a valid CodeNarc ruleset file that includes ALL rules distributed with CodeNarc.
*
* @author Chris Mair
*/
class GenerateRuleSetAllRules {
protected static final RULESET_FILE = 'src/site/resources/StarterRuleSet-AllRules.groovy.txt'
private static final TEMPLATE_FILE = 'src/main/resources/templates/StarterRuleSet-AllRules.groovy.template'
private static final LOG = Logger.getLogger(GenerateRuleSetAllRules)
protected static ruleSetFile = RULESET_FILE
/**
* Write out all current rules to the 'codenarc-base-rules.properties' properties file
* @param args - command-line args (not used)
*/
static void main(String[] args) {
def sortedRules = GenerateUtil.createSortedListOfAllRules()
LOG.debug("sortedRules=$sortedRules")
Properties ruleExtraInformation = GenerateUtil.getRuleExtraInformation()
def binding = [rules:sortedRules, ruleExtraInformation:ruleExtraInformation]
def ruleSetTemplateFile = new File(TEMPLATE_FILE)
def engine = new SimpleTemplateEngine()
def ruleSetText = engine.createTemplate(ruleSetTemplateFile).make(binding)
def outputFile = new File(ruleSetFile)
outputFile.text = ruleSetText
LOG.info("Finished writing ${sortedRules.size()} rules to $ruleSetFile")
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/CodeNarcRunner.groovy 0000644 0001750 0001750 00000010610 12311373552 024170 0 ustar ebourg ebourg /*
* 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
import org.apache.log4j.Logger
import org.codenarc.analyzer.SourceAnalyzer
import org.codenarc.results.Results
import org.codenarc.ruleregistry.RuleRegistryInitializer
import org.codenarc.ruleset.CompositeRuleSet
import org.codenarc.ruleset.PropertiesFileRuleSetConfigurer
import org.codenarc.ruleset.RuleSet
import org.codenarc.ruleset.RuleSetUtil
/**
* Helper class to run CodeNarc.
*
* The following properties must be configured before invoking the execute() method:
*
*
rulesetfiles - The path to the Groovy or XML RuleSet definition files, relative to the classpath. This can be a
* single file path, or multiple paths separated by commas.
*
sourceAnalyzer - An instance of a org.codenarc.analyzer.SourceAnalyzer implementation.
*
reportWriters - The list of ReportWriter instances. A report is generated
* for each element in this list. At least one ReportWriter must be configured.
*
*
* NOTE: This is an internal class. Its API is subject to change.
*
* @author Chris Mair
*/
class CodeNarcRunner {
private static final LOG = Logger.getLogger(CodeNarcRunner)
String ruleSetFiles
SourceAnalyzer sourceAnalyzer
List reportWriters = []
/**
* The main entry point for this class. Runs CodeNarc and returns the results. Processing steps include:
*
*
Parse the ruleSetFiles property to create a RuleSet.
*
Configure the RuleSet from the "codenarc.properties" file, if that file is found on the classpath.
*
Apply the configured SourceAnalyzer.
*
Generate a report for each configured ReportWriter.
*
Return the Results object representing the analysis results.
*
* @returns the Results object containing the results of the CodeNarc analysis.
*/
Results execute() {
assert ruleSetFiles, 'The ruleSetFiles property must be set'
assert sourceAnalyzer, 'The sourceAnalyzer property must be set to a valid SourceAnalayzer'
def startTime = System.currentTimeMillis()
new RuleRegistryInitializer().initializeRuleRegistry()
def ruleSet = createRuleSet()
new PropertiesFileRuleSetConfigurer().configure(ruleSet)
def results = sourceAnalyzer.analyze(ruleSet)
def p1 = results.getNumberOfViolationsWithPriority(1, true)
def p2 = results.getNumberOfViolationsWithPriority(2, true)
def p3 = results.getNumberOfViolationsWithPriority(3, true)
def countsText = "(p1=$p1; p2=$p2; p3=$p3)"
def elapsedTime = System.currentTimeMillis() - startTime
LOG.debug("results=$results")
def analysisContext = new AnalysisContext(ruleSet:ruleSet, sourceDirectories:sourceAnalyzer.sourceDirectories)
reportWriters.each { reportWriter ->
reportWriter.writeReport(analysisContext, results)
}
def resultsMessage = 'CodeNarc completed: ' + countsText + " ${elapsedTime}ms"
println resultsMessage
results
}
/**
* Create and return the RuleSet that provides the source of Rules to be applied.
* The returned RuleSet may aggregate multiple underlying RuleSets.
* @return a single RuleSet
*/
protected RuleSet createRuleSet() {
def paths = ruleSetFiles.tokenize(',')
def newRuleSet = new CompositeRuleSet()
paths.each { path ->
def ruleSet = RuleSetUtil.loadRuleSetFile(path.trim())
newRuleSet.addRuleSet(ruleSet)
}
newRuleSet
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/source/ 0000755 0001750 0001750 00000000000 12623571301 021351 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/source/SourceCodeCriteria.groovy 0000644 0001750 0001750 00000007531 12311373553 026347 0 ustar ebourg ebourg /*
* 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.source
import org.codenarc.util.WildcardPattern
/**
* Represents the set of criteria used to filter source code (files). Provides an API
* to determine whether a particular source code file matches the criteria.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class SourceCodeCriteria {
/**
* Apply only to source code (file) pathnames matching this regular expression.
* If null, then all SourceCode instances match this part of the criteria (i.e., this property is ignored).
*/
String applyToFilesMatching
/**
* Do NOT apply to source code (file) pathnames matching this regular expression.
* If null, then all SourceCode instances match this part of the criteria (i.e., this property is ignored).
*/
String doNotApplyToFilesMatching
/**
* Only apply to source code (file) names matching this value. The name may optionally contain a path.
* If a path is specified, then the source code path must match it. If no path is specified, then only
* the source code (file) name is compared (i.e., its path is ignored).
* The value may optionally be a comma-separated list of names, in which case one of the names must match.
* The name(s) may optionally include wildcard characters ('*' or '?').
* If null, then all SourceCode instances match this part of the criteria (i.e., this property is ignored).
*/
String applyToFileNames
/**
* Do NOT apply to source code (file) names matching this value. The name may optionally contain a path.
* If a path is specified, then the source code path must match it. If no path is specified, then only
* the source code (file) name is compared (i.e., its path is ignored).
* The value may optionally be a comma-separated list of names, in which case any one of the names can match.
* The name(s) may optionally include wildcard characters ('*' or '?').
* If null, then all SourceCode instances match this part of the criteria (i.e., this property is ignored).
*/
String doNotApplyToFileNames
/**
* Return true if all of the criteria specified in this object apply to thw SourceCode.
* @param sourceCode - the SourceCode
* @return true only if all of the (specified, i.e. non-null) criteria match the SourceCode
*/
boolean matches(SourceCode sourceCode) {
boolean apply = (applyToFilesMatching) ? sourceCode.path ==~ applyToFilesMatching : true
if (apply && doNotApplyToFilesMatching) {
apply = !(sourceCode.path ==~ doNotApplyToFilesMatching)
}
if (apply && applyToFileNames) {
def target = includesPath(applyToFileNames) ? sourceCode.path : sourceCode.name
apply = new WildcardPattern(applyToFileNames).matches(target)
}
if (apply && doNotApplyToFileNames) {
def target = includesPath(doNotApplyToFileNames) ? sourceCode.path : sourceCode.name
apply = !new WildcardPattern(doNotApplyToFileNames).matches(target)
}
apply
}
private boolean includesPath(String value) {
value.contains('/')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/source/SourceString.groovy 0000644 0001750 0001750 00000003433 12311373552 025254 0 ustar ebourg ebourg /*
* Copyright 2008 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.source
import org.codenarc.analyzer.SuppressionAnalyzer
/**
* SourceCode implementation that uses source from a pre-defined String.
* Note that the path is normalized: file separator chars are normalized to standard '/'.
*
* @author Chris Mair
*/
class SourceString extends AbstractSourceCode {
String path
String name
private final String source
/**
* Construct a new instance for the file at the specified path
* @param source - the source; must not be null or empty
* @param path - the path for the source code; may be null; defaults to null
* @param name - the name for the source code; may be null; defaults to null
*/
SourceString(String source, String path=null, String name=null) {
assert source
this.source = source
setPath(path)
this.name = name
setSuppressionAnalyzer(new SuppressionAnalyzer(this))
}
/**
* @return the full text of the source code
*/
String getText() {
source
}
void setPath(String path) {
this.path = path ? normalizePath(path) : path
}
String toString() {
"SourceString[$source]"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/source/SourceCode.groovy 0000644 0001750 0001750 00000006607 12324227505 024666 0 ustar ebourg ebourg /*
* Copyright 2008 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.source
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.ModuleNode
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.control.Phases
import org.codenarc.analyzer.SuppressionAnalyzer
/**
* Represents a unit of source code to be analyzed
*
* @author Chris Mair
*/
interface SourceCode {
public static final int DEFAULT_COMPILER_PHASE = Phases.CONVERSION
/**
* Returns information about this classes' suppressed warnings.
* @return suppression analyzer
*/
SuppressionAnalyzer getSuppressionAnalyzer()
/**
* Get the logical name for this source code. If this object is a file, then the name
* is the filename, without a path.
* @return the name for this source; may be null
*/
String getName()
/**
* Get the logical path for this source code. If this object is a file, then the name
* is the full path in the filesystem. File separators are normalized to forward slash (/).
* @return the name for this source; may be null
*/
String getPath()
/**
* @return the full text of the source code
*/
String getText()
/**
* @return the List of lines of the source code (with line terminators removed)
*/
List getLines()
/**
* Get the trimmed line at the specified index
* @param lineNumber - the zero-based line number; may be negative
* @return the trimmed line at the specified index, or null if lineNumber is not valid
*/
String line(int lineNumber)
/**
* Return the Groovy AST (Abstract Syntax Tree) for this source file
* @return the ModuleNode representing the AST for this source file
*/
ModuleNode getAst()
/**
* @return compiler phase (as in {@link org.codehaus.groovy.control.Phases}) up to which the AST will be processed
*/
int getAstCompilerPhase()
/**
* Return the line index for the line containing the character at the specified index within the source code.
* @param charIndex - the index of the character within the source code (zero-based)
* @return the line number (one-based) containing the specified character; Return -1 if charIndex is not valid.
*/
int getLineNumberForCharacterIndex(int charIndex)
/**
* Return true if and only if the source code can be successfully compiled
* @return true only if the source code is valid
*/
boolean isValid()
/**
* This method gives you all of the MethodCallExpressions defined in the AST without forcing you to walk the
* entire tree on every request. They are cached for the lifespan of the SourceCode.
* @return
*/
Map> getMethodCallExpressions()
}
CodeNarc-0.23/src/main/groovy/org/codenarc/source/SourceFile.groovy 0000644 0001750 0001750 00000003470 12311373552 024666 0 ustar ebourg ebourg /*
* Copyright 2008 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.source
import org.codenarc.analyzer.SuppressionAnalyzer
/**
* The SourceCode implementation for a single file.
* Note that the path is normalized: file separator chars are normalized to standard '/'.
*
* @author Chris Mair
*/
class SourceFile extends AbstractSourceCode {
private final File file
private final path
private String text
/**
* Construct a new instance for the file at the specified path
* @param path - the path of the file; must not be null or empty
*/
SourceFile(File file) {
assert file
this.file = file
this.path = normalizePath(file.path)
setSuppressionAnalyzer(new SuppressionAnalyzer(this))
}
/**
* @return the filename for this source file, excluding path
*/
String getName() {
file.name
}
/**
* @return the normalized path for this source file, including filename
*/
String getPath() {
path
}
/**
* @return the full text of the source code
*/
String getText() {
if (text == null) {
text = file.text
}
text
}
String toString() {
"SourceFile[$file.absolutePath]"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/source/AbstractSourceCode.groovy 0000644 0001750 0001750 00000014347 12407277435 026363 0 ustar ebourg ebourg /*
* Copyright 2008 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.source
import groovy.grape.GrabAnnotationTransformation
import org.apache.log4j.Logger
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.ModuleNode
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.control.CompilationFailedException
import org.codehaus.groovy.control.CompilationUnit
import org.codehaus.groovy.control.SourceUnit
import org.codehaus.groovy.transform.ASTTransformation
import org.codenarc.analyzer.SuppressionAnalyzer
/**
* Abstract superclass for SourceCode implementations
*
* @author Chris Mair
* @author Hamlet D'Arcy
*/
@SuppressWarnings('AbstractClassWithoutAbstractMethod')
abstract class AbstractSourceCode implements SourceCode {
static final LOG = Logger.getLogger(AbstractSourceCode)
static final SEPARATOR_PROP = 'file.separator'
private ModuleNode ast
private List lines
private astParsed = false
private final initLock = new Object()
private Map> methodCallExpressions
SuppressionAnalyzer suppressionAnalyzer
/**
* Setter exists to avoid circular dependency.
* @param suppressionAnalyzer suppression analyzer
*/
protected void setSuppressionAnalyzer(SuppressionAnalyzer suppressionAnalyzer) {
this.suppressionAnalyzer = suppressionAnalyzer
}
/**
* @return the List of lines of the source code (with line terminators removed)
*/
List getLines() {
if (lines == null) {
lines = new StringReader(getText()).readLines()
}
return lines
}
/**
* Get the trimmed line at the specified index
* @param lineNumber - the zero-based line number; may be negative
* @return the trimmed line at the specified index, or null if lineNumber is not valid
*/
String line(int lineNumber) {
def allLines = getLines()
(lineNumber >= 0) && lineNumber < allLines.size() ?
allLines[lineNumber].trim() : null
}
/**
* Return the Groovy AST (Abstract Syntax Tree) for this source file
* @return the ModuleNode representing the AST for this source file
*/
ModuleNode getAst() {
init()
ast
}
private void init() {
synchronized (initLock) {
if (!astParsed) {
SourceUnit unit = SourceUnit.create('None', getText())
CompilationUnit compUnit = new CompilationUnit()
compUnit.addSource(unit)
try {
removeGrabTransformation(compUnit)
compUnit.compile(getAstCompilerPhase())
ast = unit.getAST()
}
catch (CompilationFailedException e) {
logCompilationError(e)
}
catch (NoClassDefFoundError e) {
logCompilationError(e)
LOG.info("Most likely, a lib containing $e.message is missing from CodeNarc's runtime classpath.")
}
methodCallExpressions = new ExpressionCollector().getMethodCalls(ast)
astParsed = true
}
}
}
private void logCompilationError(Throwable e) {
LOG.warn("Compilation failed for [${toString()}].")
if (getAstCompilerPhase() <= DEFAULT_COMPILER_PHASE) {
LOG.info("Compilation failed because of [${e.class.name}] with message: [$e.message]")
}
}
/**
* @return compiler phase (as in {@link org.codehaus.groovy.control.Phases}) up to which the AST will be processed
*/
@SuppressWarnings('GetterMethodCouldBeProperty')
int getAstCompilerPhase() {
DEFAULT_COMPILER_PHASE
}
Map> getMethodCallExpressions() {
init()
methodCallExpressions.asImmutable()
}
private removeGrabTransformation(CompilationUnit compUnit) {
compUnit.phaseOperations?.each { List xforms ->
xforms?.removeAll { entry ->
entry.getClass().declaredFields.any {
it.name == 'val$instance' &&
it.type == ASTTransformation
} && entry.val$instance instanceof GrabAnnotationTransformation
}
}
}
/**
* Return the line index for the line containing the character at the specified index within the source code.
* @param charIndex - the index of the character within the source code (zero-based)
* @return the line number (one-based) containing the specified character; Return -1 if charIndex is not valid.
*/
int getLineNumberForCharacterIndex(int charIndex) {
int lineCount = 1
def source = getText()
if (charIndex >= source.size() || charIndex < 0) {
return -1
}
if (charIndex > 0) {
(charIndex - 1..0).each { index ->
def ch = source[index]
if (ch == '\n') {
lineCount++
}
}
}
lineCount
}
/**
* Return true if and only if the source code can be successfully compiled
* @return true only if the source code is valid
*/
boolean isValid() {
return getAst()
}
/**
* Return the normalized value of the specified path. Convert file separator chars to standard '/'.
* @param path - the path to normalize
* @return the normalized value
*/
protected String normalizePath(String path) {
final SEP = '/' as char
char separatorChar = System.getProperty(SEPARATOR_PROP).charAt(0)
(separatorChar == SEP) ? path : path.replace(separatorChar, SEP)
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/source/CustomCompilerPhaseSourceDecorator.groovy 0000644 0001750 0001750 00000003435 12140600454 031573 0 ustar ebourg ebourg /*
* Copyright 2013 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.source
import org.codehaus.groovy.control.Phases
import org.codenarc.analyzer.SuppressionAnalyzer
/**
* A {@link SourceCode} decorator overriding the decorated source's returned AST
* so that it meets the user's compilerPhase requirements.
*
* Ensures that the compiler phase is before classes are output to disk.
*
* @author Artur Gajowy
*/
class CustomCompilerPhaseSourceDecorator extends AbstractSourceCode {
private final SourceCode delegate
private final int compilerPhase
CustomCompilerPhaseSourceDecorator(SourceCode delegate, int compilerPhase) {
assert delegate
this.delegate = delegate
assert compilerPhase < Phases.OUTPUT
this.compilerPhase = compilerPhase
}
@Override
int getAstCompilerPhase() {
compilerPhase
}
String getName() {
delegate.name
}
String getPath() {
delegate.path
}
String getText() {
delegate.text
}
@Override
SuppressionAnalyzer getSuppressionAnalyzer() {
delegate.suppressionAnalyzer
}
String toString() {
"CustomCompilerPhaseSourceDecorator[${delegate.toString()}]"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/results/ 0000755 0001750 0001750 00000000000 12623571301 021552 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/results/DirectoryResults.groovy 0000644 0001750 0001750 00000010536 12311373552 026356 0 ustar ebourg ebourg /*
* Copyright 2008 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.results
/**
* Represents the results for a directory
*
* @author Chris Mair
*/
class DirectoryResults implements Results {
private final String path
private final List children = []
int numberOfFilesInThisDirectory = 0
/**
* Create a new uninitialized instance
*/
DirectoryResults() {
}
/**
* Create a new instance with the specified path
* @param path - the path
*/
DirectoryResults(String path) {
this.path = path
}
/**
* Create a new instance with the specified path and number of files in the directory
*/
DirectoryResults(String path, int numberOfFilesInThisDirectory) {
this.path = path
this.numberOfFilesInThisDirectory = numberOfFilesInThisDirectory
}
/**
* @return the path to the file or directory associated with these results
*/
String getPath() {
path
}
void addChild(Results child) {
children.add(child)
}
/**
* @return the List of child Results objects; may be empty
*/
List getChildren() {
children
}
/**
* @return the List of all violations; may be empty
*/
List getViolations() {
children.inject([]) { violations, child -> violations.addAll(child.getViolations()); violations }
}
/**
* Return the number of violations with the specified priority
* @param recursive - true if the returned count should include subdirectories as well; defaults to true
* @return the number of violations with the specified priority
*/
int getNumberOfViolationsWithPriority(int priority, boolean recursive=true) {
children.sum(0) { child ->
(recursive || child.isFile()) ? child.getNumberOfViolationsWithPriority(priority) : 0
}
}
/**
* Return the number of files with violations
* @param maxPriority - the maximum priority level; ignore violations with priority greater than this
* @param recursive - true if the returned count should include subdirectories as well; defaults to true
* @return the number of files containing violations
*/
int getNumberOfFilesWithViolations(int maxPriority, boolean recursive=true) {
children.sum(0) { child ->
(recursive || child.isFile()) ? child.getNumberOfFilesWithViolations(maxPriority) : 0
}
}
/**
* Return the total number of (Groovy) files analyzed
* @param recursive - true if the returned count should include subdirectories as well
* @return the total number of files (with or without violations)
*/
int getTotalNumberOfFiles(boolean recursive=true) {
def total = numberOfFilesInThisDirectory
if (recursive) {
total += children.sum(0) { child -> child.isFile() ? 0 : child.getTotalNumberOfFiles(true) }
}
total
}
/**
* @return false (this object does not represents the results for a single file)
*/
boolean isFile() {
false
}
/**
* Return the Results object with the specified path within this directory or its descendents.
* @param path - the path to search for
* @return this Results object if a match is found, otherwise null
*/
Results findResultsForPath(String path) {
if (this.path == path) {
return this
}
for(child in this.children) {
def foundResults = child.findResultsForPath(path)
if (foundResults) {
return foundResults
}
}
null
}
String toString() {
"DirectoryResults($path) $children"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/results/VirtualResults.groovy 0000644 0001750 0001750 00000003661 12145021324 026031 0 ustar ebourg ebourg /*
* 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.results
/**
* This is a Results object for something that has no real file system, such as a string.
*
* @author Hamlet D'Arcy
*/
class VirtualResults implements Results {
private final List violations
VirtualResults(List violations) {
this.violations = violations
}
List getViolations() {
return new ArrayList(violations)
}
String getPath() {
throw new UnsupportedOperationException('Not supported on virtual results')
}
List getChildren() {
throw new UnsupportedOperationException('Not supported on virtual results')
}
@Override
int getNumberOfViolationsWithPriority(int priority, boolean recursive) {
throw new UnsupportedOperationException('Not supported on virtual results')
}
@Override
int getTotalNumberOfFiles(boolean recursive) {
throw new UnsupportedOperationException('Not supported on virtual results')
}
@Override
int getNumberOfFilesWithViolations(int maxPriority, boolean recursive) {
throw new UnsupportedOperationException('Not supported on virtual results')
}
@Override
boolean isFile() {
false
}
@Override
Results findResultsForPath(String path) {
throw new UnsupportedOperationException('Not supported on virtual results')
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/results/Results.groovy 0000644 0001750 0001750 00000005070 12311373552 024466 0 ustar ebourg ebourg /*
* Copyright 2008 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.results
/**
* Represents the results of applying rules to one or more source files/directories
*
* @author Chris Mair
*/
interface Results {
/**
* @return the path to the file or directory associated with these results
*/
String getPath()
/**
* @return the List of child Results objects; may be empty
*/
List getChildren()
/**
* @return the List of all violations; may be empty
*/
List getViolations()
/**
* Return the number of violations with the specified priority
* @param priority - the priority
* @param recursive - true if the returned count should include subdirectories as well
* @return the number of violations with the specified priority
*/
int getNumberOfViolationsWithPriority(int priority, boolean recursive)
/**
* Return the total number of (Groovy) files analyzed
* @param recursive - true if the returned count should include subdirectories as well
* @return the total number of files (with or without violations)
*/
int getTotalNumberOfFiles(boolean recursive)
/**
* Return the number of files with violations
* @param maxPriority - the maximum priority level; ignore violations with priority greater than this
* @param recursive - true if the returned count should include subdirectories as well
* @return the number of files containing violations
*/
int getNumberOfFilesWithViolations(int maxPriority, boolean recursive)
/**
* @return true only if this object represents the results for a single file
*/
boolean isFile()
/**
* Return the Results object with the specified path within this results object or its descendents.
* @param path - the path to search for
* @return this Results object if a match is found, otherwise null
*/
Results findResultsForPath(String path)
}
CodeNarc-0.23/src/main/groovy/org/codenarc/results/FileResults.groovy 0000644 0001750 0001750 00000006204 12463037530 025267 0 ustar ebourg ebourg /*
* Copyright 2008 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.results
/**
* Represents the results of applying a set of rules against a single sourcefile
*
* @author Chris Mair
*/
@SuppressWarnings('UnusedMethodParameter')
class FileResults implements Results {
private final String path
private final List violations
FileResults(String path, List violations) {
this.path = path
this.violations = violations
}
/**
* @return the path to the file or directory associated with these results
*/
String getPath() {
path
}
/**
* @return true (this object represents the results for a single file)
*/
boolean isFile() {
true
}
/**
* Return an empty List
* @return the List of child Results objects; may be empty
*/
List getChildren() {
Collections.EMPTY_LIST
}
/**
* @return the List of all violations
*/
List getViolations() {
new ArrayList(violations)
}
/**
* @param recursive - ignored
* @return the number of violations with the specified priority
*/
//@Override - causes compile error in Groovy 2.4.0
int getNumberOfViolationsWithPriority(int priority, boolean recursive=true) {
violations.sum(0) { violation -> violation.rule.priority == priority ? 1 : 0 }
}
/**
* Return the total number of (Groovy) files analyzed
* @param recursive - ignored
* @return the total number of files (with or without violations)
*/
//@Override - causes compile error in Groovy 2.4.0
int getTotalNumberOfFiles(boolean recursive=true) {
1
}
/**
* Return 1 if these results include at least one violation
* @param maxPriority - the maximum priority level; ignore violations with priority greater than this
* @param recursive - ignored
* @return the number of files containing violations
*/
//@Override - causes compile error in Groovy 2.4.0
int getNumberOfFilesWithViolations(int maxPriority, boolean recursive=true) {
violations.find { v -> v.rule.priority <= maxPriority } ? 1 : 0
}
/**
* Return the Results object with the specified path.
* @param path - the path to search for
* @return this Results object if the path matches, otherwise null
*/
Results findResultsForPath(String path) {
this.path == path ? this : null
}
String toString() {
"FileResults($path) $violations"
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/AnalysisContext.groovy 0000644 0001750 0001750 00000002066 12311373552 024456 0 ustar ebourg ebourg /*
* 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
import org.codenarc.ruleset.RuleSet
/**
* Holds information related to the configuration and context for the source code analysis.
*
* @author Chris Mair
*/
class AnalysisContext {
/**
* The List of source directories being analyzed. May be null or empty.
*/
List sourceDirectories
/**
* The RuleSet containing the rules being applied.
*/
RuleSet ruleSet
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ant/ 0000755 0001750 0001750 00000000000 12623571301 020633 5 ustar ebourg ebourg CodeNarc-0.23/src/main/groovy/org/codenarc/ant/Report.groovy 0000644 0001750 0001750 00000002160 12311373552 023356 0 ustar ebourg ebourg /*
* Copyright 2008 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.ant
/**
* JavaBean class holding the properties for a element with the CodeNarc Ant Task.
*
* @see CodeNarcTask
*
* @author Chris Mair
*/
class Report {
String type
/** @deprecated Use option elements instead */
String title
/** @deprecated Use option elements instead */
String toFile
final Map options = [:]
void addConfiguredOption(ReportOption option) {
options[option.name] = option.value
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ant/CodeNarcTask.groovy 0000644 0001750 0001750 00000012243 12311373552 024407 0 ustar ebourg ebourg /*
* Copyright 2008 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.ant
import org.apache.log4j.Logger
import org.apache.tools.ant.BuildException
import org.apache.tools.ant.Task
import org.apache.tools.ant.types.FileSet
import org.codenarc.CodeNarcRunner
import org.codenarc.analyzer.SourceAnalyzer
import org.codenarc.report.ReportWriterFactory
import org.codenarc.results.Results
/**
* Ant Task for running CodeNarc.
*
* The ruleSetFiles property specifies the path to the Groovy or XML RuleSet
* definition files, relative to the classpath. This can be a single file path, or multiple
* paths separated by commas. It is required.
*
* The maxPriority1Violations property specifies the maximum number of priority 1
* violations allowed before failing the build (throwing a BuildException). Likewise,
* maxPriority2Violations and maxPriority3Violations specifiy the
* thresholds for violations of priority 2 and 3.
*
* At least one nested fileset element is required, and is used to specify the source files
* to be analyzed. This is the standard Ant FileSet, and is quite powerful and flexible.
* See the Apache Ant Manual for more information on FileSets.
*
* The report nested element defines the format and output file for the analysis report.
* Currently, HTML (type="html") and XML (type="xml") are the only supported formats. Each report
* is configured using nested option elements, with name, and
* value attributes.
*
* @see "http://ant.apache.org/manual/index.html"
*
* @author Chris Mair
*/
class CodeNarcTask extends Task {
private static final LOG = Logger.getLogger(CodeNarcTask)
/**
* The path to the Groovy or XML RuleSet definition files, relative to the classpath. This can be a
* single file path, or multiple paths separated by commas.
*/
String ruleSetFiles
int maxPriority1Violations = Integer.MAX_VALUE
int maxPriority2Violations = Integer.MAX_VALUE
int maxPriority3Violations = Integer.MAX_VALUE
protected List reportWriters = []
protected List fileSets = []
protected ruleSet
// Abstract creation of the CodeNarcRunner instance to allow substitution of test spy for unit tests
protected createCodeNarcRunner = { new CodeNarcRunner() }
/**
* Execute this Ant Task
*/
void execute() throws BuildException {
assert ruleSetFiles
assert fileSets
def sourceAnalyzer = createSourceAnalyzer()
def codeNarcRunner = createCodeNarcRunner()
codeNarcRunner.ruleSetFiles = ruleSetFiles
codeNarcRunner.reportWriters = reportWriters
codeNarcRunner.sourceAnalyzer = sourceAnalyzer
def results = codeNarcRunner.execute()
checkMaxViolations(results)
}
void addFileset(FileSet fileSet) {
assert fileSet
this.fileSets << fileSet
}
/**
* Ant-defined method (by convention), called with each instance of a nested
* element within this task.
*/
void addConfiguredReport(Report report) {
def reportWriter = new ReportWriterFactory().getReportWriter(report.type, report.options)
if (report.title) {
reportWriter.title = report.title
}
if (report.toFile) {
reportWriter.outputFile = report.toFile
}
LOG.debug("Adding report: $reportWriter")
reportWriters << reportWriter
}
/**
* Create and return the SourceAnalyzer
* @return a configured SourceAnalyzer instance
*/
protected SourceAnalyzer createSourceAnalyzer() {
new AntFileSetSourceAnalyzer(getProject(), fileSets)
}
private void checkMaxViolations(Results results) {
def p1 = results.getNumberOfViolationsWithPriority(1, true)
def p2 = results.getNumberOfViolationsWithPriority(2, true)
def p3 = results.getNumberOfViolationsWithPriority(3, true)
def countsText = "(p1=$p1; p2=$p2; p3=$p3)"
checkMaxViolationForPriority(1, p1, countsText)
checkMaxViolationForPriority(2, p2, countsText)
checkMaxViolationForPriority(3, p3, countsText)
}
private void checkMaxViolationForPriority(int priority, int count, String countsText) {
if (count > this."maxPriority${priority}Violations") {
throw new BuildException("Exceeded maximum number of priority ${priority} violations: " + countsText)
}
}
}
CodeNarc-0.23/src/main/groovy/org/codenarc/ant/ReportOption.groovy 0000644 0001750 0001750 00000001621 12311373552 024550 0 ustar ebourg ebourg /*
* 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.ant
/**
* JavaBean class holding the properties for a
