Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rule to check for ArrayNew and suggest using [] instead #90

Merged
merged 3 commits into from
Oct 12, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions src/main/java/com/cflint/plugins/core/ArrayNewChecker.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package com.cflint.plugins.core;

import ro.fortsoft.pf4j.Extension;
import net.htmlparser.jericho.Element;

import cfml.parsing.cfscript.CFExpression;
import cfml.parsing.cfscript.script.CFExpressionStatement;
import cfml.parsing.cfscript.script.CFScriptStatement;

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

@Extension
public class ArrayNewChecker extends CFLintScannerAdapter {
final String severity = "INFO";

@Override
public void expression(final CFScriptStatement expression, final Context context, final BugList bugs) {
if (expression instanceof CFExpressionStatement) {
String code = ((CFExpressionStatement) expression).getExpression().Decompile(0);
int lineNo = ((CFExpressionStatement) expression).getLine() + context.startLine() - 1;

if (code.toLowerCase().contains("arraynew(1)")) {
arrayNew(lineNo, context, bugs);
}
}
}

@Override
public void element(final Element element, final Context context, final BugList bugs) {
if (element.getName().equals("cfset")) {
String content = element.getStartTag().getTagContent().toString();
int lineNo = element.getSource().getRow(element.getBegin());

if (content.toLowerCase().contains("arraynew(1)")) {
arrayNew(lineNo, context, bugs);
}
}
}

protected void arrayNew(final int lineNo, final Context context, final BugList bugs) {
bugs.add(new BugInfo.BugInfoBuilder().setLine(lineNo).setMessageCode("AVOID_USING_ARRAYNEW")
.setSeverity(severity).setFilename(context.getFilename())
.setMessage("ArrayNew statement at line " + lineNo + ". Use implict array construction instead (= []).")
.build());
}
}
5 changes: 5 additions & 0 deletions src/main/resources/cflint.definition.xml
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,9 @@
<severity>INFO</severity>
</message>
</ruleImpl>
<ruleImpl name="ArrayNewChecker" className="ArrayNewChecker">
<message code="AVOID_USING_ARRAYNEW">
<severity>INFO</severity>
</message>
</ruleImpl>
</CFLint-Plugin>
70 changes: 70 additions & 0 deletions src/test/java/com/cflint/TestArrayNewChecker.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
package com.cflint;

import static org.junit.Assert.assertEquals;

import java.io.IOException;
import java.util.List;

import org.junit.Before;
import org.junit.Test;

import cfml.parsing.reporting.ParseException;

import com.cflint.config.CFLintPluginInfo.PluginInfoRule;
import com.cflint.config.CFLintPluginInfo.PluginInfoRule.PluginMessage;
import com.cflint.config.ConfigRuntime;
import com.cflint.plugins.core.ArrayNewChecker;

public class TestArrayNewChecker {

private CFLint cfBugs;

@Before
public void setUp() {
final ConfigRuntime conf = new ConfigRuntime();
final PluginInfoRule pluginRule = new PluginInfoRule();
pluginRule.setName("ArrayNewChecker");
conf.getRules().add(pluginRule);
final PluginMessage pluginMessage = new PluginMessage("AVOID_USING_ARRAYNEW");
pluginMessage.setSeverity("INFO");
cfBugs = new CFLint(conf, new ArrayNewChecker());
}

@Test
public void testArrayNewInScript() throws ParseException, IOException {
final String scriptSrc = "<cfscript>\r\n"
+ "var a = 23;\r\n"
+ "var b = arrayNew(1);\r\n"
+ "</cfscript>";

cfBugs.process(scriptSrc, "test");
final List<BugInfo> result = cfBugs.getBugs().getBugList().values().iterator().next();
assertEquals(1, result.size());
assertEquals("AVOID_USING_ARRAYNEW", result.get(0).getMessageCode());
assertEquals(3, result.get(0).getLine());
}

@Test
public void testArrayNewMultiDimentionInScript() throws ParseException, IOException {
final String scriptSrc = "<cfscript>\r\n"
+ "var a = 23;\r\n"
+ "var b = arrayNew(3);\r\n"
+ "</cfscript>";

cfBugs.process(scriptSrc, "test");
assertEquals(0, cfBugs.getBugs().getBugList().size());
}

@Test
public void testArrayNewInTag() throws ParseException, IOException {
final String tagSrc = "<cfset a = 23>\r\n"
+ "<cfset b = arrayNew(1)>";

cfBugs.process(tagSrc, "test");
final List<BugInfo> result = cfBugs.getBugs().getBugList().values().iterator().next();
assertEquals(1, result.size());
assertEquals("AVOID_USING_ARRAYNEW", result.get(0).getMessageCode());
assertEquals(2, result.get(0).getLine());
}

}