com.google.errorprone.bugpatterns.PackageLocation Maven / Gradle / Ivy
/*
* Copyright 2015 The Error Prone 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 com.google.errorprone.bugpatterns;
import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION;
import static java.lang.Math.max;
import com.google.common.base.Joiner;
import com.google.common.base.Splitter;
import com.google.errorprone.BugPattern;
import com.google.errorprone.BugPattern.StandardTags;
import com.google.errorprone.VisitorState;
import com.google.errorprone.annotations.SuppressPackageLocation;
import com.google.errorprone.bugpatterns.BugChecker.CompilationUnitTreeMatcher;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.util.ASTHelpers;
import com.sun.source.tree.CompilationUnitTree;
import com.sun.tools.javac.code.Symbol.PackageSymbol;
import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
import java.util.List;
/** A {@link BugChecker}; see the associated {@link BugPattern} annotation for details. */
@BugPattern(
summary = "Package names should match the directory they are declared in",
severity = SUGGESTION,
documentSuppression = false,
suppressionAnnotations = SuppressPackageLocation.class,
tags = StandardTags.STYLE,
altNames = "PackageName")
public class PackageLocation extends BugChecker implements CompilationUnitTreeMatcher {
private static final Splitter DOT_SPLITTER = Splitter.on('.');
private static final Splitter PATH_SPLITTER = Splitter.on('/');
@Override
public Description matchCompilationUnit(CompilationUnitTree tree, VisitorState state) {
if (tree.getPackageName() == null) {
return Description.NO_MATCH;
}
// package-info annotations are special
// TODO(cushon): fix the core suppression logic to handle this
if (ASTHelpers.hasAnnotation(tree.getPackage(), SuppressPackageLocation.class, state)) {
return Description.NO_MATCH;
}
PackageSymbol packageSymbol = ((JCCompilationUnit) state.getPath().getCompilationUnit()).packge;
if (packageSymbol == null) {
return Description.NO_MATCH;
}
String packageName = packageSymbol.fullname.toString();
String actualFileName = ASTHelpers.getFileName(tree);
if (actualFileName == null) {
return Description.NO_MATCH;
}
List actualPath =
PATH_SPLITTER.splitToList(actualFileName.substring(0, actualFileName.lastIndexOf('/')));
List expectedSuffix = DOT_SPLITTER.splitToList(packageName);
List actualSuffix =
actualPath.subList(max(0, actualPath.size() - expectedSuffix.size()), actualPath.size());
if (actualSuffix.equals(expectedSuffix)) {
return Description.NO_MATCH;
}
String message =
String.format(
"Expected package %s to be declared in a directory ending with %s, instead found %s",
packageName, Joiner.on('/').join(expectedSuffix), Joiner.on('/').join(actualSuffix));
return buildDescription(tree.getPackageName()).setMessage(message).build();
}
}