org.codenarc.rule.formatting.LineLengthRule.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of CodeNarc Show documentation

The CodeNarc project provides a static analysis tool for Groovy code.

There is a newer version: 3.5.0-groovy-4.0

/*
 * 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.rule.Violation
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
 * @author Chris Mair
  */
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 length
    boolean ignorePackageStatements = true // import statements can be longer than the max line length
    String ignoreLineRegex

    @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) && !lineMatchesIgnoreLineRegex(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
    }

    private boolean lineMatchesIgnoreLineRegex(String line) {
        line ==~ ignoreLineRegex
    }

}