added allowFinal to VariableInitialisation, fixes HaxeCheckstyle#491

AlexHaxe · Dec 14, 2019 · 2047063 · 2047063
1 parent e32c1e8
commit 2047063
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## dev branch / next version (2.x.x)
 
+- Added `allowFinal` setting to `VariableInitialisation`, fixes [#491](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/491)
+
 ## version 2.6.0 (2019-12-01)
 
 - **Breaking Change** changed `MethodLength.countEmpty` into `ignoreEmptyLines` ([#486](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/486))

diff --git a/resources/checkstyle-schema.json b/resources/checkstyle-schema.json
@@ -3900,6 +3900,11 @@
                     "description": "Checks for instance variables that are initialised at class level.",
                     "additionalProperties": false,
                     "properties": {
+                        "allowFinal": {
+                            "description": "final fields must be initialised either immediately or in constructor\n\t\twhen allowFinal is true then VariableInitialisation won't complain about initialisation at class level for final fields",
+                            "type": "boolean",
+                            "propertyOrder": 0
+                        },
                         "severity": {
                             "description": "sets gravity of reported violations:\n\t- IGNORE = do not report violations, violations do not appear anywhere in output\n\t- INFO = all violations have info / lowest priority\n\t- WARNING = all violations have warning / medium priority\n\t- ERROR = all violations have error / highest priority",
                             "type": "string",
@@ -3909,7 +3914,7 @@
                                 "ERROR",
                                 "IGNORE"
                             ],
-                            "propertyOrder": 0
+                            "propertyOrder": 1
                         }
                     },
                     "type": "object"

diff --git a/resources/default-config.json b/resources/default-config.json
@@ -648,7 +648,9 @@
 		},
 		{
 			"type": "VariableInitialisation",
-			"props": {}
+			"props": {
+				"allowFinal": false
+			}
 		},
 		{
 			"type": "WhitespaceAfter",

diff --git a/src/checkstyle/checks/coding/VariableInitialisationCheck.hx b/src/checkstyle/checks/coding/VariableInitialisationCheck.hx
@@ -6,10 +6,17 @@ package checkstyle.checks.coding;
 @name("VariableInitialisation")
 @desc("Checks for instance variables that are initialised at class level.")
 class VariableInitialisationCheck extends Check {
+	/**
+		final fields must be initialised either immediately or in constructor
+		when allowFinal is true then VariableInitialisation won't complain about initialisation at class level for final fields
+	**/
+	public var allowFinal:Bool;
+
 	public function new() {
 		super(AST);
 		categories = [Category.STYLE, Category.CLARITY];
 		points = 2;
+		allowFinal = false;
 	}
 
 	override function actualRun() {
@@ -21,14 +28,20 @@ class VariableInitialisationCheck extends Check {
 
 		var isPrivate = false;
 		var isPublic = false;
-		var isInline = false;
-		var isStatic = false;
+		var isInline = f.access.contains(AInline);
+		var isStatic = f.access.contains(AStatic);
+		var isFinal = false;
+
+		if (isInline || isStatic) return;
 
-		if (f.access.contains(AInline)) isInline = true;
-		else if (f.access.contains(AStatic)) isStatic = true;
-		else if (f.access.contains(APublic)) isPublic = true;
+		if (f.access.contains(APublic)) isPublic = true;
 		else isPrivate = true;
 
+		#if haxe4
+		if (f.access.contains(AFinal)) isFinal = true;
+		#end
+		if (allowFinal && isFinal) return;
+
 		if (isPrivate || isPublic) {
 			switch (f.kind) {
 				case FVar(t, e):
@@ -40,6 +53,6 @@ class VariableInitialisationCheck extends Check {
 	}
 
 	function warnVarInit(name:String, pos:Position) {
-		logPos('Invalid variable "${name}" initialisation (move initialisation to constructor or function)', pos);
+		logPos('Invalid variable initialisation for "${name}" (move initialisation to constructor or function)', pos);
 	}
 }
diff --git a/test/checkstyle/checks/coding/VariableInitialisationCheckTest.hx b/test/checkstyle/checks/coding/VariableInitialisationCheckTest.hx
@@ -3,7 +3,7 @@ package checkstyle.checks.coding;
 class VariableInitialisationCheckTest extends CheckTestCase<VariableInitialisationCheckTests> {
 	@Test
 	public function testVar() {
-		assertMsg(new VariableInitialisationCheck(), TEST1, 'Invalid variable "_a" initialisation (move initialisation to constructor or function)');
+		assertMsg(new VariableInitialisationCheck(), TEST1, 'Invalid variable initialisation for "_a" (move initialisation to constructor or function)');
 	}
 
 	@Test
@@ -15,6 +15,16 @@ class VariableInitialisationCheckTest extends CheckTestCase<VariableInitialisati
 	public function testEnumAbstract() {
 		assertNoMsg(new VariableInitialisationCheck(), TEST3);
 	}
+
+	@Test
+	public function testFinal() {
+		var check:VariableInitialisationCheck = new VariableInitialisationCheck();
+		assertMsg(check, FINAL, 'Invalid variable initialisation for "VALUE" (move initialisation to constructor or function)');
+		assertNoMsg(check, FINAL_CONSTRUCTOR);
+		check.allowFinal = true;
+		assertNoMsg(check, FINAL);
+		assertNoMsg(check, FINAL_CONSTRUCTOR);
+	}
 }
 
 @:enum
@@ -31,6 +41,7 @@ abstract VariableInitialisationCheckTests(String) to String {
 	var TEST2 = "
 	abstractAndClass Test {
 		static inline var TEST:Int = 1;
+		inline var TEST2:Int = 1;
 
 		public function new() {}
 	}";
@@ -39,4 +50,16 @@ abstract VariableInitialisationCheckTests(String) to String {
 	abstract Test(Int) {
 		var VALUE = 0;
 	}";
+	var FINAL = "
+	abstractAndClass Test {
+		final VALUE = 0;
+	}";
+	var FINAL_CONSTRUCTOR = "
+	abstractAndClass Test {
+		final VALUE;
+
+		public function new() {
+			VALUE = 1;
+		}
+	}";
 }