org.codenarc.rule.design.PublicInstanceFieldRule.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.design

import org.codehaus.groovy.ast.FieldNode
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractFieldVisitor

/**
 * Using public fields is considered to be a bad design. Use properties instead.
 *
 * @author Victor Savkin
  */
class PublicInstanceFieldRule extends AbstractAstVisitorRule {
    String name = 'PublicInstanceField'
    int priority = 2
    Class astVisitorClass = PublicInstanceFieldAstVisitor
}

class PublicInstanceFieldAstVisitor extends AbstractFieldVisitor {

    @Override
    void visitField(FieldNode node) {
        if(node.public && !node.static) {
            addViolation node, createErrorMessage(node)
        }
    }

    private static String createErrorMessage(FieldNode node) {
        "Using public fields is considered bad design. Create property '$node.name' instead."
    }
}