org.codenarc.rule.generic.RequiredStringRule.groovy Maven / Gradle / Ivy

Go to download
/*
 * 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]"))
        }
    }

}