Field Detail

• protected static final java.lang.Object CONSTRUCTOR_METHOD_NAME

• protected static final java.lang.Object DEFAULT_TEST_CLASS_NAMES

• protected static final java.lang.Object DEFAULT_TEST_FILES

• protected T rule

• protected java.lang.String sourceCodeName

• protected java.lang.String sourceCodePath

Method Detail

• protected java.util.List applyRuleTo(java.lang.String source)

  Apply the current Rule to the specified source (String) and return the resulting List of Violations.

  Parameters:

  source - - the full source code to which the rule is applied, as a String

• protected void assertInlineViolations(java.lang.String annotatedSource)

  Apply the current Rule to the specified source (String) and assert that it results in the violations specified inline within the source.

  Inline violations can be specified either by using the inlineViolation(java.lang.String) method or simply by prefixing a violation message with a '#'. Multiple inline violations per line are allowed.

  One can prevent a '#' character from starting a violation message by escaping it with a '\' character (keep in mind that most of Groovy's string literal syntax demands the '\' to be escaped itself, as a '\\' sequence).

  For every source line all text after the first non-escaped '#' character is part of some inline violation message (with the sole exception of the first line of a Groovy script beginning with a shebang). More precisely, every '#' character that is neither escaped nor part of a shebang starts an inline violation that spans to the end of its line or until next non-escaped '#' character.

  See the inlineViolation(java.lang.String) method.
  See the removeInlineViolations(java.lang.String) method.
  

  Parameters:

  source - - the full source code to which the rule is applied annotated with inline violations, as a String

• protected void assertNoViolations(java.lang.String source)

  Apply the current Rule to the specified source (String) and assert that it results in no violations.

  Parameters:

  source - - the full source code to which the rule is applied, as a String

• @java.lang.SuppressWarnings('MethodParameterTypeRequired') protected void assertSingleViolation(java.lang.String source, java.lang.Integer lineNumber = null, java.lang.String sourceLineText = null, java.lang.Object messageText = null)

  Apply the current Rule to the specified source (String) and assert that it results in a single violation with the specified line number and containing the specified source text.

  Parameters:

  source - - the full source code to which the rule is applied, as a String

  lineNumber - - the expected line number in the resulting violation; defaults to null

  sourceLineText - - the text expected within the sourceLine of the resulting violation; defaults to null

  messageText - - the text expected within the message of the resulting violation; May be a String or List of Strings; Defaults to null;

• protected void assertSingleViolation(java.lang.String source, groovy.lang.Closure closure)

  Apply the current Rule to the specified source (String) and assert that it results in a single violation and that the specified closure returns true.

  Parameters:

  source - - the full source code to which the rule is applied, as a String; defaults to null

  closure - - the closure to apply to the violation; takes a single Violation parameter

• protected void assertTwoViolations(java.lang.String source, java.lang.Integer lineNumber1, java.lang.String sourceLineText1, java.lang.Integer lineNumber2, java.lang.String sourceLineText2)

  Apply the current Rule to the specified source (String) and assert that it results in two violations with the specified line numbers and containing the specified source text values.

  Parameters:

  source - - the full source code to which the rule is applied, as a String

  lineNumber1 - - the expected line number in the first violation

  sourceLineText1 - - the text expected within the sourceLine of the first violation

  lineNumber2 - - the expected line number in the second violation

  sourceLineText2 - - the text expected within the sourceLine of the second violation

• @java.lang.SuppressWarnings(['ParameterCount', 'MethodParameterTypeRequired']) protected void assertTwoViolations(java.lang.String source, java.lang.Integer lineNumber1, java.lang.String sourceLineText1, java.lang.Object msg1, java.lang.Integer lineNumber2, java.lang.String sourceLineText2, java.lang.Object msg2)

  Apply the current Rule to the specified source (String) and assert that it results in two violations with the specified line numbers and containing the specified source text values.

  Parameters:

  source - - the full source code to which the rule is applied, as a String

  lineNumber1 - - the expected line number in the first violation

  sourceLineText1 - - the text expected within the sourceLine of the first violation

  msg1 - - the text expected within the message of the first violation; May be a String or List of Strings; Defaults to null;

  lineNumber2 - - the expected line number in the second violation

  sourceLineText2 - - the text expected within the sourceLine of the second violation

  msg2 - - the text expected within the message of the second violation; May be a String or List of Strings; Defaults to null;

• @java.lang.SuppressWarnings('MethodParameterTypeRequired') protected void assertViolation(Violation violation, java.lang.Integer lineNumber, java.lang.String sourceLineText, java.lang.Object messageText = null)

  Assert that the specified violation is for the current rule, and has expected line number and contains the specified source text and message text.

  Parameters:

  violation - - the Violation

  lineNumber - - the expected line number in the resulting violation

  sourceLineText - - the text expected within the sourceLine of the resulting violation; may be null

  messageText - - the text expected within the message of the resulting violation; May be a String or List of Strings; Defaults to null;

• protected void assertViolations(java.lang.String source, java.util.Map[] violationMaps)

  Apply the current Rule to the specified source (String) and assert that it results in the violations specified in violationMaps.

  Parameters:

  source - - the full source code to which the rule is applied, as a String

  violationMaps - - a list (array) of Maps, each describing a single violation. Each element in the map can contain a line/lineNumber, source/sourceLineText and message/messageText entries.

• protected T createRule()

  Create and return a new instance of the Rule class to be tested.

  Returns:

  a new Rule instance

• protected static java.lang.String inlineViolation(java.lang.String violationMessage)

  Prepares an inline violation with a given message, escaping all '#' characters and preventing accidental escaping of next inline violation's start when the message ends with a '\' character.

  Parameters:

  violationMessage - message for the inline violation

  Returns:

  a String that will be interpreted as an inline violation by the assertInlineViolations(java.lang.String) method

• protected java.util.List manuallyApplyRule(java.lang.String source)

  Apply the current Rule to the specified source (String) and return the resulting List of Violations.

  Parameters:

  source - - the full source code to which the rule is applied, as a String

• protected static java.lang.String removeInlineViolations(java.lang.String annotatedSource)

  Removes all inline violations from a source.

  Parameters:

  annotatedSource - source possibly containing inline violations

  Returns:

  the given source with inline violations removed

• @org.junit.Before void setUpAbstractRuleTestCase()

• @org.junit.Test void testThatApplyToFilesMatchingValuesAreValidRegex()

• @org.junit.Test void testThatInvalidCodeHasNoViolations()

• @org.junit.Test void testThatUnrelatedCodeHasNoViolations()

  Make sure that code unrelated to the rule under test causes no violations. Subclasses can skip this rule by defining a property named 'skipTestThatUnrelatedCodeHasNoViolations'.