All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 3.5.0-groovy-4.0
Show newest version
/*
 * Copyright 2009 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 regular expression that must exist within the source code.
 * 

* The regex property specifies the regular expression 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, regex, violationMessage and (optionally) customized priority. * * @author Chris Mair */ class RequiredRegexRule extends AbstractRule { String name = 'RequiredRegex' int priority = 3 String regex @Override boolean isReady() { regex } @Override void applyTo(SourceCode sourceCode, List violations) { if (!(sourceCode.getText() =~ regex)) { violations.add(new Violation(rule:this, message:"Match not found for required regular expression \"$regex\"")) } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy