
org.codenarc.rule.formatting.SpaceBeforeClosingBraceRule.groovy Maven / Gradle / Ivy
/*
* 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
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy