net.sourceforge.pmd.doc.internal.RuleSetUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pmd-doc Show documentation
There is a newer version: 7.6.0
/**
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.doc.internal;

import java.io.File;
import java.util.regex.Pattern;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.SystemUtils;

import net.sourceforge.pmd.internal.util.IOUtil;
import net.sourceforge.pmd.lang.rule.Rule;
import net.sourceforge.pmd.lang.rule.RuleReference;
import net.sourceforge.pmd.lang.rule.RuleSet;

public final class RuleSetUtils {

    private RuleSetUtils() {
        // Utility class
    }

    /**
     * Gets the sanitized base name of the ruleset.
     * For some reason, the filename might contain some newlines, which are removed.
     * @param ruleset
     * @return
     */
    public static String getRuleSetFilename(RuleSet ruleset) {
        return getRuleSetFilename(ruleset.getFileName());
    }

    public static String getRuleSetFilename(String rulesetFileName) {
        return IOUtil.getFilenameBase(StringUtils.chomp(rulesetFileName));
    }

    /**
     * A ruleset is considered deprecated, if it only contains rule references
     * and all rule references are deprecated.
     *
     * @param ruleset
     * @return
     */
    public static boolean isRuleSetDeprecated(RuleSet ruleset) {
        boolean result = true;
        for (Rule rule : ruleset.getRules()) {
            if (!(rule instanceof RuleReference) || !rule.isDeprecated()) {
                result = false;
                break;
            }
        }
        return result;
    }

    public static String getRuleSetClasspath(RuleSet ruleset) {
        final String RESOURCES_PATH = "/resources/";
        String filename = normalizeForwardSlashes(StringUtils.chomp(ruleset.getFileName()));
        int startIndex = filename.lastIndexOf(RESOURCES_PATH);
        if (startIndex > -1) {
            return filename.substring(startIndex + RESOURCES_PATH.length());
        } else {
            return filename;
        }
    }

    public static String normalizeForwardSlashes(String path) {
        String normalized = IOUtil.normalizePath(path);
        if (SystemUtils.IS_OS_WINDOWS) {
            // Note: windows path separators are changed to forward slashes,
            // so that the editme link works
            normalized = normalized.replaceAll(Pattern.quote(File.separator), "/");
        }
        return normalized;
    }

    /**
     * Recursively resolves rule references until the last reference.
     * The last reference is returned.
     * If the given rule not a reference, the rule is returned.
     *
     * @param rule
     * @return
     */
    public static Rule resolveRuleReferences(Rule rule) {
        Rule result = rule;
        Rule ref = rule;
        while (ref instanceof RuleReference) {
            // remember the last reference
            result = ref;
            ref = ((RuleReference) ref).getRule();
        }
        return result;
    }
}