TouchInstinct
/
checkstyle
306
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added enum processing to TypeNameCheck

This commit is contained in:
Pavel Baranchikov 2014-02-21 11:59:44 +04:00
parent f1cff12b20
commit 686d009cf4
5 changed files with 108 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/AbstractNameCheck.java
View File

@ -32,6 +32,11 @@ import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
public abstract class AbstractNameCheck
extends AbstractFormatCheck
{
/**
* Message key for invalid pattern error.
*/
public static final String MSG_INVALID_PATTERN = "name.invalidPattern";
/**
* Creates a new <code>AbstractNameCheck</code> instance.
* @param aFormat format to check with
@ -61,7 +66,7 @@ public abstract class AbstractNameCheck
if (!getRegexp().matcher(nameAST.getText()).find()) {
log(nameAST.getLineNo(),
nameAST.getColumnNo(),
"name.invalidPattern",
MSG_INVALID_PATTERN,
nameAST.getText(),
getFormat());
}

11
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheck.java
View File

@ -48,12 +48,17 @@ public class TypeNameCheck
extends AbstractAccessControlNameCheck
{
/**
* default pattern for type name.
*/
public static final String DEFAULT_PATTERN = "^[A-Z][a-zA-Z0-9]*$";
/**
* Creates a new <code>TypeNameCheck</code> instance.
*/
public TypeNameCheck()
{
super("^[A-Z][a-zA-Z0-9]*$");
super(DEFAULT_PATTERN);
}
/** {@inheritDoc} */
@ -61,6 +66,8 @@ public class TypeNameCheck
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF, };
TokenTypes.INTERFACE_DEF,
TokenTypes.ENUM_DEF,
};
}
}

9
src/testinputs/com/puppycrawl/tools/checkstyle/naming/InputTypeName.java Normal file
View File

@ -0,0 +1,9 @@
package com.puppycrawl.tools.checkstyle.naming;
class inputHeaderClass {
public interface inputHeaderInterface {};
public enum inputHeaderEnum { one, two };
}

86
src/tests/com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheckTest.java
View File

@ -18,23 +18,42 @@
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.naming;
import java.io.File;
import java.io.IOException;
import java.text.MessageFormat;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import org.junit.Test;
public class TypeNameCheckTest
extends BaseCheckTestSupport
{
/**
* Localized error message from @link {@link TypeNameCheck}.
*/
private final String msg = getCheckMessage(AbstractNameCheck.MSG_INVALID_PATTERN);
private final String inputFilename;
public TypeNameCheckTest() throws IOException
{
inputFilename = getPath("naming" + File.separator
+ "InputTypeName.java");
}
@Test
public void testSpecified()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(TypeNameCheck.class);
createCheckConfig(TypeNameCheck.class);
checkConfig.addAttribute("format", "^inputHe");
final String[] expected = {
};
verify(checkConfig, getPath("inputHeader.java"), expected);
verify(checkConfig, inputFilename, expected);
}
@Test
@ -42,10 +61,65 @@ public class TypeNameCheckTest
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(TypeNameCheck.class);
createCheckConfig(TypeNameCheck.class);
final String[] expected = {
"1:48: Name 'inputHeader' must match pattern '^[A-Z][a-zA-Z0-9]*$'.",
buildMesssage(3, 7, "inputHeaderClass",
TypeNameCheck.DEFAULT_PATTERN),
buildMesssage(5, 22, "inputHeaderInterface",
TypeNameCheck.DEFAULT_PATTERN),
buildMesssage(7, 17, "inputHeaderEnum",
TypeNameCheck.DEFAULT_PATTERN),
};
verify(checkConfig, getPath("inputHeader.java"), expected);
verify(checkConfig, inputFilename, expected);
}
@Test
public void testClassSpecific()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(TypeNameCheck.class);
checkConfig.addAttribute("tokens", "CLASS_DEF");
final String[] expected = {
buildMesssage(3, 7, "inputHeaderClass",
TypeNameCheck.DEFAULT_PATTERN),
};
verify(checkConfig, inputFilename, expected);
}
@Test
public void testInterfaceSpecific()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(TypeNameCheck.class);
checkConfig.addAttribute("tokens", "INTERFACE_DEF");
final String[] expected = {
buildMesssage(5, 22, "inputHeaderInterface",
TypeNameCheck.DEFAULT_PATTERN),
};
verify(checkConfig, inputFilename, expected);
}
@Test
public void testEnumSpecific()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(TypeNameCheck.class);
checkConfig.addAttribute("tokens", "ENUM_DEF");
final String[] expected = {
buildMesssage(7, 17, "inputHeaderEnum",
TypeNameCheck.DEFAULT_PATTERN),
};
verify(checkConfig, inputFilename, expected);
}
private String buildMesssage(int lineNumber, int colNumber, String name,
String pattern)
{
return lineNumber + ":" + colNumber + ": "
+ MessageFormat.format(msg, name, pattern);
}
}

7
src/xdocs/config_naming.xml
View File

@ -111,7 +111,7 @@
</tr>
<tr>
<td><code>TypeName</code></td>
<td>classes and interfaces</td>
<td>classes, interfaces and enums</td>
<td><code>^[A-Z][a-zA-Z0-9]*$</code></td>
</tr>
</table>
@ -142,8 +142,9 @@
<p>
Module <code>TypeName</code> also has property
<code>tokens</code> which can be used to control whether the
check applies to classes or interfaces through tokens
<code>CLASS_DEF</code> and <code>INTERFACE_DEF</code>. For
check applies to classes, interfaces and enums through tokens
<code>CLASS_DEF</code>, <code>INTERFACE_DEF</code> and
<code>ENUM_DEF</code>. For
example, the following configuration element ensures that
interface names begin with <code>"I_"</code>, followed by
letters and digits: