com.cflint.plugins.core.MethodNameChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of CFLint Show documentation
A static code analysis tool for ColdFusion (in the spirit of FindBugs and Lint). With CFLint, you are able to analyze your ColdFusion code base for code violations.
There is a newer version: 1.5.0
Show newest version
package com.cflint.plugins.core;

import com.cflint.BugInfo;
import com.cflint.BugList;
import com.cflint.plugins.CFLintScannerAdapter;
import com.cflint.plugins.Context;

import cfml.parsing.cfscript.script.CFFuncDeclStatement;
import cfml.parsing.cfscript.script.CFScriptStatement;
import net.htmlparser.jericho.Element;
import ro.fortsoft.pf4j.Extension;

@Extension
public class MethodNameChecker extends CFLintScannerAdapter {
	public static final String METHOD_NAME = "Method name ";
	final String severity = "INFO";

	@Override
	public void expression(final CFScriptStatement expression, final Context context, final BugList bugs) {
		if (expression instanceof CFFuncDeclStatement) {
			final CFFuncDeclStatement method = (CFFuncDeclStatement) expression;
			final int lineNo = method.getLine() + context.startLine() - 1;
			checkNameForBugs(context.getFunctionName(), context.getFilename(), context.getFunctionName(), lineNo, bugs);
		}
	}

	@Override
	public void element(final Element element, final Context context, final BugList bugs) {
		if (element.getName().equals("cffunction")) {
			final int lineNo = element.getSource().getRow(element.getBegin());
			checkNameForBugs(context.getFunctionName(), context.getFilename(), context.getFunctionName(), lineNo, bugs);
		}
	}

	public void checkNameForBugs(final String method, final String filename, final String functionName, final int line,
			final BugList bugs) {
		int minMethodLength = ValidName.MIN_METHOD_LENGTH;
		int maxMethodLength = ValidName.MAX_METHOD_LENGTH;
		int maxMethodWords = ValidName.MAX_METHOD_WORDS;

		if (getParameter("MinLength") != null) {
			try {
				minMethodLength = Integer.parseInt(getParameter("MinLength"));
			} catch (final Exception e) {
			}
		}

		if (getParameter("MaxLength") != null) {
			try {
				maxMethodLength = Integer.parseInt(getParameter("MaxLength"));
			} catch (final Exception e) {
			}
		}

		if (getParameter("MaxWords") != null) {
			try {
				maxMethodWords = Integer.parseInt(getParameter("MaxWords"));
			} catch (final Exception e) {
			}
		}

		final ValidName name = new ValidName(minMethodLength, maxMethodLength, maxMethodWords);

		if (name.isInvalid(method)) {
			bugs.add(new BugInfo.BugInfoBuilder().setLine(line).setMessageCode("METHOD_INVALID_NAME")
					.setSeverity(severity).setFilename(filename).setFunction(functionName)
					.setMessage(METHOD_NAME + method + " is not a valid name. Please use CamelCase or underscores.")
					.build());
		}
		if (name.isUpperCase(method)) {
			bugs.add(new BugInfo.BugInfoBuilder().setLine(line).setMessageCode("METHOD_ALLCAPS_NAME")
					.setSeverity(severity).setFilename(filename).setFunction(functionName)
					.setMessage(METHOD_NAME + method + " should not be upper case.").build());
		}
		if (name.tooShort(method)) {
			bugs.add(new BugInfo.BugInfoBuilder().setLine(line).setMessageCode("METHOD_TOO_SHORT").setSeverity(severity)
					.setFilename(filename).setFunction(functionName)
					.setMessage(METHOD_NAME + method + " should be longer than " + minMethodLength + " characters.")
					.build());
		}
		if (name.tooLong(method)) {
			bugs.add(new BugInfo.BugInfoBuilder().setLine(line).setMessageCode("METHOD_TOO_LONG").setSeverity(severity)
					.setFilename(filename).setFunction(functionName)
					.setMessage(METHOD_NAME + method + " should be shorter than " + maxMethodLength + " characters.")
					.build());
		}
		if (!name.isUpperCase(method) && name.tooWordy(method)) {
			bugs.add(new BugInfo.BugInfoBuilder().setLine(line).setMessageCode("METHOD_TOO_WORDY").setSeverity(severity)
					.setFilename(filename).setFunction(functionName)
					.setMessage(METHOD_NAME + method + " is too wordy, can you think of a more concise name?").build());
		}
		if (name.isTemporary(method)) {
			bugs.add(new BugInfo.BugInfoBuilder().setLine(line).setMessageCode("METHOD_IS_TEMPORARY")
					.setSeverity(severity).setFilename(filename).setFunction(functionName)
					.setMessage(METHOD_NAME + method + " could be named better.").build());
		}
		if (name.hasPrefixOrPostfix(method)) {
			bugs.add(new BugInfo.BugInfoBuilder().setLine(line).setMessageCode("METHOD_HAS_PREFIX_OR_POSTFIX")
					.setSeverity(severity).setFilename(filename).setFunction(functionName)
					.setMessage("Method name has prefix or postfix " + method + " and could be named better.").build());
		}
	}
}