Merge pull request #779 from danielzaenker/rename-rules

Rename rules NotAllFieldsOfSerializableClassSerializable and OverridesNotNonCps

docs/codenarc-rules-jenkins.md

@@ -120,7 +120,7 @@ void cpsMethod() {
 }
 ```
 
-## OverridesNotNonCps Rule
+## ObjectOverrideOnlyNonCpsMethods Rule
 
 *Since CodeNarc 3.5.0*
 

docs/codenarc-rules-serialization.md

@@ -100,7 +100,7 @@ An example of a missing serialVersionUID:
     }
 ```
 
-## NotAllFieldsOfSerializableClassSerializable Rule
+## NonSerializableFieldInSerializableClass Rule
 
 *Since CodeNarc 3.5.0*
 

src/main/groovy/org/codenarc/rule/jenkins/OverridesNotNonCpsRule.groovy → src/main/groovy/org/codenarc/rule/jenkins/ObjectOverrideOnlyNonCpsMethods.groovy

@@ -27,16 +27,16 @@ import org.codenarc.rule.AbstractMethodVisitor
  *
  * @author Daniel Zänker
  */
-class OverridesNotNonCpsRule extends AbstractAstVisitorRule {
+class ObjectOverrideOnlyNonCpsMethods extends AbstractAstVisitorRule {
 
-    String name = 'OverridesNotNonCps'
+    String name = 'ObjectOverrideOnlyNonCpsMethods'
     int priority = 2
-    Class astVisitorClass = OverridesNotNonCpsAstVisitor
+    Class astVisitorClass = ObjectOverrideOnlyNonCpsMethodsVisitor
     int compilerPhase = Phases.SEMANTIC_ANALYSIS
     String applyToFileNames = 'Jenkinsfile'
 }
 
-class OverridesNotNonCpsAstVisitor extends AbstractMethodVisitor {
+class ObjectOverrideOnlyNonCpsMethodsVisitor extends AbstractMethodVisitor {
     final static List<Map> OBJECT_METHODS = [
         [name: 'clone', parameters: []],
         [name: 'equals', parameters: [ClassHelper.make(Object)]],

src/main/groovy/org/codenarc/rule/serialization/NotAllFieldsOfSerializableClassSerializableRule.groovy → src/main/groovy/org/codenarc/rule/serialization/NonSerializableFieldInSerializableClass.groovy

@@ -26,15 +26,15 @@ import org.codenarc.util.AstUtil
  *
  * @author Daniel Zänker
  */
-class NotAllFieldsOfSerializableClassSerializableRule extends AbstractAstVisitorRule {
+class NonSerializableFieldInSerializableClass extends AbstractAstVisitorRule {
 
-    String name = 'NotAllFieldsOfSerializableClassSerializable'
+    String name = 'NonSerializableFieldInSerializableClass'
     int priority = 2
-    Class astVisitorClass = NotAllFieldsOfSerializableClassSerializableAstVisitor
+    Class astVisitorClass = NonSerializableFieldInSerializableClassVisitor
     int compilerPhase = Phases.SEMANTIC_ANALYSIS
 }
 
-class NotAllFieldsOfSerializableClassSerializableAstVisitor extends AbstractAstVisitor {
+class NonSerializableFieldInSerializableClassVisitor extends AbstractAstVisitor {
 
     @Override
     void visitField(FieldNode field) {

src/main/resources/codenarc-base-messages.properties

@@ -1,11 +1,11 @@
-NotAllFieldsOfSerializableClassSerializable.description=All fields of a class that implements Serializable should also implement it
-NotAllFieldsOfSerializableClassSerializable.description.html=All fields of a class that implements Serializable should also implement it
+NonSerializableFieldInSerializableClass.description=All fields of a class that implements Serializable should also implement it
+NonSerializableFieldInSerializableClass.description.html=All fields of a class that implements Serializable should also implement it
 
 ParameterOrReturnTypeNotSerializable.description=Every parameter and return type has to implement the Serializable interface in Jenkins
 ParameterOrReturnTypeNotSerializable.description.html=Every parameter and return type has to implement the Serializable interface in Jenkins
 
-OverridesNotNonCps.description=Overridden methods of the standard library (e.g. from java.lang.Object) are often called from there and therefore must not be CPS transformed in Jenkins
-OverridesNotNonCps.description.html=Overridden methods of the standard library (e.g. from java.lang.Object) are often called from there and therefore must not be CPS transformed in Jenkins
+ObjectOverrideOnlyNonCpsMethods.description=Overridden methods of the standard library (e.g. from java.lang.Object) are often called from there and therefore must not be CPS transformed in Jenkins
+ObjectOverrideOnlyNonCpsMethods.description.html=Overridden methods of the standard library (e.g. from java.lang.Object) are often called from there and therefore must not be CPS transformed in Jenkins
 
 ForbiddenCallInCpsMethod.description=Some methods from the standard library cannot be CPS transformed and therefore must not be called from CPS transformed methods in Jenkins
 ForbiddenCallInCpsMethod.description.html=Some methods from the standard library cannot be CPS transformed and therefore must not be called from CPS transformed methods in Jenkins

src/main/resources/codenarc-base-rules.properties

@@ -243,13 +243,13 @@ NoTabCharacter = org.codenarc.rule.convention.NoTabCharacterRule
 NoWildcardImports = org.codenarc.rule.imports.NoWildcardImportsRule
 NonFinalPublicField = org.codenarc.rule.security.NonFinalPublicFieldRule
 NonFinalSubclassOfSensitiveInterface = org.codenarc.rule.security.NonFinalSubclassOfSensitiveInterfaceRule
-NotAllFieldsOfSerializableClassSerializable = org.codenarc.rule.serialization.NotAllFieldsOfSerializableClassSerializableRule
+NonSerializableFieldInSerializableClass = org.codenarc.rule.serialization.NonSerializableFieldInSerializableClass
 ObjectFinalize = org.codenarc.rule.security.ObjectFinalizeRule
 ObjectOverrideMisspelledMethodName = org.codenarc.rule.naming.ObjectOverrideMisspelledMethodNameRule
 OptionalCollectionReturnType = org.codenarc.rule.design.OptionalCollectionReturnTypeRule
 OptionalField = org.codenarc.rule.design.OptionalFieldRule
 OptionalMethodParameter = org.codenarc.rule.design.OptionalMethodParameterRule
-OverridesNotNonCps = org.codenarc.rule.jenkins.OverridesNotNonCpsRule
+ObjectOverrideOnlyNonCpsMethods = org.codenarc.rule.jenkins.ObjectOverrideOnlyNonCpsMethods
 PackageName = org.codenarc.rule.naming.PackageNameRule
 PackageNameMatchesFilePath = org.codenarc.rule.naming.PackageNameMatchesFilePathRule
 ParameterAssignmentInFilterClosure = org.codenarc.rule.basic.ParameterAssignmentInFilterClosureRule

src/main/resources/rulesets/jenkins.xml

@@ -10,7 +10,7 @@
     </description>
 
     <rule class='org.codenarc.rule.jenkins.ParameterOrReturnTypeNotSerializableRule'/>
-    <rule class='org.codenarc.rule.jenkins.OverridesNotNonCpsRule'/>
+    <rule class='org.codenarc.rule.jenkins.ObjectOverrideOnlyNonCpsMethods'/>
     <rule class='org.codenarc.rule.jenkins.ForbiddenCallInCpsMethodRule'/>
     <rule class='org.codenarc.rule.jenkins.ExpressionInCpsMethodNotSerializableRule'/>
     <rule class='org.codenarc.rule.jenkins.CpsCallFromNonCpsMethodRule'/>

src/main/resources/rulesets/serialization.xml

@@ -9,7 +9,7 @@
     </description>
 
     <rule class='org.codenarc.rule.serialization.EnumCustomSerializationIgnoredRule'/>
-    <rule class='org.codenarc.rule.serialization.NotAllFieldsOfSerializableClassSerializableRule'/>
+    <rule class='org.codenarc.rule.serialization.NonSerializableFieldInSerializableClass'/>
     <rule class='org.codenarc.rule.serialization.SerialPersistentFieldsRule'/>
     <rule class='org.codenarc.rule.serialization.SerialVersionUIDRule'/>
     <rule class='org.codenarc.rule.serialization.SerializableClassMustDefineSerialVersionUIDRule'/>

src/test/groovy/org/codenarc/rule/jenkins/OverridesNotNonCpsRuleTest.groovy → src/test/groovy/org/codenarc/rule/jenkins/ObjectOverrideOnlyNonCpsMethodsTest.groovy

@@ -18,19 +18,19 @@ package org.codenarc.rule.jenkins
 import org.junit.jupiter.api.Test
 
 /**
- * Tests for OverridesNotNonCpsRule
+ * Tests for ObjectOverrideOnlyNonCpsMethods
  *
  * Note: Usage of com.cloudbees.groovy.cps.NonCPS intentionally commented out for test purposes to mark where it would be used in a real use case.
  * This is necessary because we don't want to add this to the test dependencies.
  *
  * @author Daniel Zänker
  */
-class OverridesNotNonCpsRuleTest extends AbstractJenkinsRuleTestCase<OverridesNotNonCpsRule> {
+class ObjectOverrideOnlyNonCpsMethodsTest extends AbstractJenkinsRuleTestCase<ObjectOverrideOnlyNonCpsMethods> {
 
     @Test
     void testRuleProperties() {
         assert rule.priority == 2
-        assert rule.name == 'OverridesNotNonCps'
+        assert rule.name == 'ObjectOverrideOnlyNonCpsMethods'
     }
 
     @Test
@@ -111,7 +111,7 @@ class OverridesNotNonCpsRuleTest extends AbstractJenkinsRuleTestCase<OverridesNo
     }
 
     @Override
-    protected OverridesNotNonCpsRule createRule() {
-        new OverridesNotNonCpsRule()
+    protected ObjectOverrideOnlyNonCpsMethods createRule() {
+        new ObjectOverrideOnlyNonCpsMethods()
     }
 }

src/test/groovy/org/codenarc/rule/serialization/NotAllFieldsOfSerializableClassSerializableRuleTest.groovy → src/test/groovy/org/codenarc/rule/serialization/NonSerializableFieldInSerializableClassTest.groovy

@@ -19,16 +19,16 @@ import org.codenarc.rule.AbstractRuleTestCase
 import org.junit.jupiter.api.Test
 
 /**
- * Tests for NotAllFieldsOfSerializableClassSerializableRule
+ * Tests for NonSerializableFieldInSerializableClass
  *
  * @author Daniel Zänker
  */
-class NotAllFieldsOfSerializableClassSerializableRuleTest extends AbstractRuleTestCase<NotAllFieldsOfSerializableClassSerializableRule> {
+class NonSerializableFieldInSerializableClassTest extends AbstractRuleTestCase<NonSerializableFieldInSerializableClass> {
 
     @Test
     void testRuleProperties() {
         assert rule.priority == 2
-        assert rule.name == 'NotAllFieldsOfSerializableClassSerializable'
+        assert rule.name == 'NonSerializableFieldInSerializableClass'
     }
 
     @Test
@@ -98,7 +98,7 @@ class NotAllFieldsOfSerializableClassSerializableRuleTest extends AbstractRuleTe
     }
 
     @Override
-    protected NotAllFieldsOfSerializableClassSerializableRule createRule() {
-        new NotAllFieldsOfSerializableClassSerializableRule()
+    protected NonSerializableFieldInSerializableClass createRule() {
+        new NonSerializableFieldInSerializableClass()
     }
 }