org.codenarc.source.SourceCodeCriteria.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
Show all versions of CodeNarc Show documentation
The CodeNarc project provides a static analysis tool for Groovy code.
/*
* 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.source
import org.codenarc.util.WildcardPattern
/**
* Represents the set of criteria used to filter source code (files). Provides an API
* to determine whether a particular source code file matches the criteria.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
*/
class SourceCodeCriteria {
/**
* Apply only to source code (file) pathnames matching this regular expression.
* If null, then all SourceCode instances match this part of the criteria (i.e., this property is ignored).
*/
String applyToFilesMatching
/**
* Do NOT apply to source code (file) pathnames matching this regular expression.
* If null, then all SourceCode instances match this part of the criteria (i.e., this property is ignored).
*/
String doNotApplyToFilesMatching
/**
* Only apply to source code (file) names matching this value. The name may optionally contain a path.
* If a path is specified, then the source code path must match it. If no path is specified, then only
* the source code (file) name is compared (i.e., its path is ignored).
* The value may optionally be a comma-separated list of names, in which case one of the names must match.
* The name(s) may optionally include wildcard characters ('*' or '?').
* If null, then all SourceCode instances match this part of the criteria (i.e., this property is ignored).
*/
String applyToFileNames
/**
* Do NOT apply to source code (file) names matching this value. The name may optionally contain a path.
* If a path is specified, then the source code path must match it. If no path is specified, then only
* the source code (file) name is compared (i.e., its path is ignored).
* The value may optionally be a comma-separated list of names, in which case any one of the names can match.
* The name(s) may optionally include wildcard characters ('*' or '?').
* If null, then all SourceCode instances match this part of the criteria (i.e., this property is ignored).
*/
String doNotApplyToFileNames
/**
* Return true if all of the criteria specified in this object apply to thw SourceCode.
* @param sourceCode - the SourceCode
* @return true only if all of the (specified, i.e. non-null) criteria match the SourceCode
*/
boolean matches(SourceCode sourceCode) {
boolean apply = (applyToFilesMatching) ? sourceCode.path ==~ applyToFilesMatching : true
if (apply && doNotApplyToFilesMatching) {
apply = !(sourceCode.path ==~ doNotApplyToFilesMatching)
}
if (apply && applyToFileNames) {
def target = includesPath(applyToFileNames) ? sourceCode.path : sourceCode.name
apply = new WildcardPattern(applyToFileNames).matches(target)
}
if (apply && doNotApplyToFileNames) {
def target = includesPath(doNotApplyToFileNames) ? sourceCode.path : sourceCode.name
apply = !new WildcardPattern(doNotApplyToFileNames).matches(target)
}
apply
}
private boolean includesPath(String value) {
value.contains('/')
}
}