Analysis Details

Adhere to generally accepted naming conventions

es.uniovi.reflection.analyses.bloch.8.56.1

This rule detects types whose names do not follow the CamelCase convention. It also checks that methods, non-final local variable, parameters and fields follow the camelCase convention, excepting static final (constant) fields that must follow the SNAKE_CASE.

Computational Reflection Research Group

12-03-2025 17:14

Program Understandability

Declaration

CALL{
MATCH (constant:ATTR_DEC {isStatic: true, isFinal: true, isUserCode:TRUE})
  WHERE NOT constant.name =~ '^[A-Z_]+$'
RETURN es.uniovi.reflection.codeanalysis.functions.getEnclosingType(constant) as typeDec, constant.lineNumber as line, constant.column as column, 'FIELD static final ' + constant.actualType + ' ' + constant.name as desc,'The constant (static final) field ' + constant.name + ' does not follow the Java (upper) SNAKE_CASE code convention' as message
UNION
MATCH (declaration:DECLARATION)
  WHERE NOT declaration.name =~ '^[a-z][a-zA-Z0-9]*$' AND ((declaration:METHOD_DEC OR declaration:ATTR_DEC AND NOT (declaration.isFinal AND declaration.isStatic)) AND declaration.isUserCode OR declaration:LOCAL_DEC AND NOT declaration.isFinal)
WITH declaration, CASE WHEN declaration:METHOD_DEC THEN 'METHOD ' + declaration.fullyQualifiedName ELSE 'DECLARATION ' + declaration.actualType + ' ' + declaration.name END as desc
RETURN es.uniovi.reflection.codeanalysis.functions.getEnclosingType(declaration) as typeDec, declaration.lineNumber as line, declaration.column as column, desc,'The ' + desc + ' does not follow the Java (lower) camelCase code convention' as message
UNION
MATCH (typeDec:TYPE_DEC{isUserCode:TRUE}) WHERE NOT typeDec.simpleName =~ '^[A-Z][a-zA-Z0-9]*$' RETURN typeDec, typeDec.lineNumber as line , typeDec.column as column, 'TYPE ' + typeDec.fullyQualifiedName as desc, 'The type ' + typeDec.simpleName + ' does not follow the Java (upper) CamelCase code convention' as message
}
MATCH (enclosingCU:COMPILATION_UNIT)-[:DECLARES_TYPE | HAS_NESTED_TYPE]->(typeDec)
RETURN '{"node":"'+desc+'","line":"'+line+'","column":"'+column+'","rule":"BLOCH-8.56.1","location":"'+enclosingCU.fileName+'","message":"'+message+'"}'