Merge pull request #5 from adireddy/dev

Adi · Adi · commit 29cceee1d5e4 · 2015-05-15T07:34:00.000+01:00
Dev
diff --git a/README.md b/README.md
@@ -104,13 +104,16 @@ More information in [wiki page](https://github.com/adireddy/haxe-checkstyle/wiki
 		{
 			"type": "PublicPrivate",
 			"props": {
-				"severity": "INFO"
+				"severity": "INFO",
+				"enforcePublicPrivate": false
 			}
 		},
 		{
 			"type": "Return",
 			"props": {
-				"severity": "INFO"
+				"severity": "INFO",
+				"allowEmptyReturn": true,
+				"enforceReturnType": false
 			}
 		},
 		{
@@ -121,7 +124,6 @@ More information in [wiki page](https://github.com/adireddy/haxe-checkstyle/wiki
 				"spaceAroundBinop": true,
 				"spaceAroundBinop": true,
 				"ignoreRangeOperator": true
-				
 			}
 		},
 		{
diff --git a/build.hxml b/build.hxml
@@ -3,7 +3,7 @@
 -lib hxparse:3.0.0
 -lib haxeparser
 -lib haxeparser-substituted:1.0.1
--lib compiletime:2.5.0
+-lib compiletime:2.5.1
 -lib hxargs:3.0.0
 
 --each
@@ -14,4 +14,4 @@
 --next
 -cp test
 -main TestMain
---interp
+--interp
diff --git a/checkstyle/checks/BlockFormatCheck.hx b/checkstyle/checks/BlockFormatCheck.hx
@@ -7,6 +7,7 @@ import checkstyle.LintMessage.SeverityLevel;
 class BlockFormatCheck extends Check {
 
 	public var severity:String = "INFO";
+	public var emptyBlockCheck:Bool = true;
 
 	var firstLineRE = ~/\{[\/*]?\s*$/;
 	var lastLineRE = ~/^\s*\}[,;\/*]?/;
@@ -15,7 +16,7 @@ class BlockFormatCheck extends Check {
 		ExprUtils.walkFile(_checker.ast, function(e) {
 			switch(e.expr){
 				case EBlock([]) | EObjectDecl([]):
-					if (e.pos.max - e.pos.min > "{}".length)
+					if (emptyBlockCheck && e.pos.max - e.pos.min > "{}".length)
 						logPos("Empty block should be written as {}", e.pos, Reflect.field(SeverityLevel, severity));
 				case EBlock(_) | EObjectDecl(_):
 					var lmin = _checker.getLinePos(e.pos.min).line;
diff --git a/checkstyle/checks/PublicPrivateCheck.hx b/checkstyle/checks/PublicPrivateCheck.hx
@@ -9,6 +9,7 @@ import haxe.macro.Expr;
 class PublicPrivateCheck extends Check {
 
 	public var severity:String = "INFO";
+	public var enforcePublicPrivate:Bool = false;
 
 	override function _actualRun() {
 		for (td in _checker.ast.decls) {
@@ -30,16 +31,32 @@ class PublicPrivateCheck extends Check {
 	}
 
 	function checkInterfaceField(f:Field) {
-		if (f.access.indexOf(APublic) > -1) {
-			_warnPublicKeyword(f.name, f.pos);
-			return;
+		if (enforcePublicPrivate) {
+			if (f.access.indexOf(APublic) < 0) {
+				_warnPublicKeywordMissing(f.name, f.pos);
+				return;
+			}
+		}
+		else {
+			if (f.access.indexOf(APublic) > -1) {
+				_warnPublicKeyword(f.name, f.pos);
+				return;
+			}
 		}
 	}
 
 	function checkField(f:Field) {
-		if (f.access.indexOf(APrivate) > -1) {
-			_warnPrivateKeyword(f.name, f.pos);
-			return;
+		if (enforcePublicPrivate) {
+			if ((f.access.indexOf(APublic) < 0) && (f.access.indexOf(APrivate) < 0)) {
+				_warnPrivateKeywordMissing(f.name, f.pos);
+				return;
+			}
+		}
+		else {
+			if (f.access.indexOf(APrivate) > -1) {
+				_warnPrivateKeyword(f.name, f.pos);
+				return;
+			}
 		}
 	}
 
@@ -50,4 +67,12 @@ class PublicPrivateCheck extends Check {
 	function _warnPublicKeyword(name:String, pos:Position) {
 		logPos('No need of public keyword: ${name} (fields are by default public in interfaces)', pos, Reflect.field(SeverityLevel, severity));
 	}
-}
+
+	function _warnPrivateKeywordMissing(name:String, pos:Position) {
+		logPos('Missing private keyword: ${name}', pos, Reflect.field(SeverityLevel, severity));
+	}
+
+	function _warnPublicKeywordMissing(name:String, pos:Position) {
+		logPos('Missing public keyword: ${name}', pos, Reflect.field(SeverityLevel, severity));
+	}
+}
diff --git a/checkstyle/checks/ReturnCheck.hx b/checkstyle/checks/ReturnCheck.hx
@@ -10,6 +10,7 @@ class ReturnCheck extends Check {
 
 	public var severity:String = "INFO";
 	public var allowEmptyReturn:Bool = true;
+	public var enforceReturnType:Bool = false;
 
 	override function _actualRun() {
 		for (td in _checker.ast.decls) {
@@ -28,8 +29,20 @@ class ReturnCheck extends Check {
 	}
 
 	function checkField(f:Field) {
-		if (Std.string(f.kind).indexOf("ret => TPath({ name => Void") > -1) {
-			_warnVoid(f.name, f.pos);
+		if (enforceReturnType) {
+			switch (f.kind) {
+				case FFun(fun):
+					if (fun.ret == null) {
+						_warnReturnTypeMissing(f.name, f.pos);
+					}
+					return;
+				default:
+			}
+		}
+		else {
+			if (Std.string(f.kind).indexOf("ret => TPath({ name => Void") > -1) {
+				_warnVoid(f.name, f.pos);
+			}
 		}
 		if (allowEmptyReturn && Std.string(f.kind).indexOf("EReturn(null)") > -1) return;
 		if (Std.string(f.kind).indexOf("expr => EReturn") > -1 && Std.string(f.kind).indexOf("ret => null") > -1) {
@@ -44,4 +57,8 @@ class ReturnCheck extends Check {
 	function _warnNoReturnType(name:String, pos:Position) {
 		logPos('Return type not specified when returning a value for function: ${name}', pos, Reflect.field(SeverityLevel, severity));
 	}
-}
+
+	function _warnReturnTypeMissing(name:String, pos:Position) {
+		logPos('Return type not specified for function: ${name}', pos, Reflect.field(SeverityLevel, severity));
+	}
+}
diff --git a/haxelib.json b/haxelib.json
@@ -10,8 +10,8 @@
 	],
 	"description": "Automated code analysis ideal for projects that want to enforce a coding standard.",
 	"contributors": ["adireddy"],
-	"releasenote": "added allowEmptyReturn config for ReturnCheck",
-	"version": "1.0.6",
+	"releasenote": "added emptyBlockCheck config for BlockFormatCheck",
+	"version": "1.0.7",
 	"url": "https://github.com/adireddy/haxe-checkstyle",
 	"dependencies": {
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "checkstyle",
-	"version": "1.0.6",
+	"version": "1.0.7",
 	"description": "Automated code analysis ideal for projects that want to enforce a coding standard.",
 	"repository": {
 		"type": "git",
diff --git a/resources/config.json b/resources/config.json
@@ -15,7 +15,8 @@
 		{
 			"type": "BlockFormat",
 			"props": {
-				"severity": "ERROR"
+				"severity": "ERROR",
+				"emptyBlockCheck": false
 			}
 		},
 		{
diff --git a/run.n b/run.n
diff --git a/test/BlockFormatCheckTest.hx b/test/BlockFormatCheckTest.hx
@@ -23,6 +23,13 @@ class BlockFormatCheckTest extends CheckTestCase {
 		var msg = checkMessage(BlockFormatTests.TEST3, new BlockFormatCheck());
 		assertEquals(msg, 'Last line of multiline block should contain only } and maybe , or ;');
 	}
+
+	public function testDisabledBlockFormat() {
+		var test = new BlockFormatCheck();
+		test.emptyBlockCheck = false;
+		var msg = checkMessage(BlockFormatTests.TEST4, test);
+		assertEquals(msg, '');
+	}
 }
 
 class BlockFormatTests {
@@ -50,4 +57,11 @@ class BlockFormatTests {
 		public function new() {
 			var a:Int; }
 	}";
+
+	public static inline var TEST4:String = "
+	class Test {
+		public function new() {
+		
+		}
+	}";
 }
diff --git a/test/PublicPrivateCheckTest.hx b/test/PublicPrivateCheckTest.hx
@@ -7,6 +7,8 @@ class PublicPrivateCheckTest extends CheckTestCase {
 	public function testCorrectUsage() {
 		var msg = checkMessage(PublicPrivateTests.TEST, new PublicPrivateCheck());
 		assertEquals(msg, '');
+		msg = checkMessage(PublicPrivateTests.TEST3, new PublicPrivateCheck());
+		assertEquals(msg, '');
 	}
 
 	public function testNormalClass() {
@@ -18,6 +20,34 @@ class PublicPrivateCheckTest extends CheckTestCase {
 		var msg = checkMessage(PublicPrivateTests.TEST2, new PublicPrivateCheck());
 		assertEquals(msg, 'No need of public keyword: a (fields are by default public in interfaces)');
 	}
+
+	public function testClassWithEnforce() {
+		var check = new PublicPrivateCheck ();
+		check.enforcePublicPrivate = true;
+		var msg = checkMessage(PublicPrivateTests.TEST1, check);
+		assertEquals(msg, '');
+	}
+
+	public function testClassWithEnforceMissing() {
+		var check = new PublicPrivateCheck ();
+		check.enforcePublicPrivate = true;
+		var msg = checkMessage(PublicPrivateTests.TEST, check);
+		assertEquals(msg, 'Missing private keyword: _onUpdate');
+	}
+
+	public function testInterfaceWithEnforce() {
+		var check = new PublicPrivateCheck ();
+		check.enforcePublicPrivate = true;
+		var msg = checkMessage(PublicPrivateTests.TEST2, check);
+		assertEquals(msg, '');
+	}
+
+	public function testInterfaceWithEnforceMissing() {
+		var check = new PublicPrivateCheck ();
+		check.enforcePublicPrivate = true;
+		var msg = checkMessage(PublicPrivateTests.TEST3, check);
+		assertEquals(msg, 'Missing public keyword: a');
+	}
 }
 
 class PublicPrivateTests {
@@ -42,4 +72,9 @@ class PublicPrivateTests {
 	interface Test {
 		public var a:Int;
 	}";
-}
+
+	public static inline var TEST3:String = "
+	interface Test {
+		var a:Int;
+	}";
+}
diff --git a/test/ReturnCheckTest.hx b/test/ReturnCheckTest.hx
@@ -18,6 +18,50 @@ class ReturnCheckTest extends CheckTestCase {
 		var msg = checkMessage(ReturnTests.TEST3, new ReturnCheck());
 		assertEquals(msg, '');
 	}
+
+	public function testEnforceReturnType() {
+		var check = new ReturnCheck ();
+		check.enforceReturnType = true;
+		var msg = checkMessage(ReturnTests.TEST1, check);
+		assertEquals(msg, '');
+		msg = checkMessage(ReturnTests.TEST4, check);
+		assertEquals(msg, '');
+	}
+
+	public function testEnforceReturnTypeMissing() {
+		var check = new ReturnCheck ();
+		check.enforceReturnType = true;
+		var msg = checkMessage(ReturnTests.TEST1, check);
+		assertEquals(msg, '');
+
+		msg = checkMessage(ReturnTests.TEST2, check);
+		assertEquals(msg, 'Return type not specified for function: test1');
+
+		msg = checkMessage(ReturnTests.TEST3, check);
+		assertEquals(msg, 'Return type not specified for function: test2');
+	}
+
+	public function testReturnTypeAllowEmptyReturnFalse() {
+		var check = new ReturnCheck ();
+		check.allowEmptyReturn = false;
+
+		var msg = checkMessage(ReturnTests.TEST2, check);
+		assertEquals(msg, 'Return type not specified when returning a value for function: test1');
+
+		msg = checkMessage(ReturnTests.TEST3, check);
+		assertEquals(msg, 'Return type not specified when returning a value for function: test2');
+	}
+
+	public function testReturnTypeAllowEmptyReturnTrue() {
+		var check = new ReturnCheck ();
+		check.allowEmptyReturn = true;
+
+		var msg = checkMessage(ReturnTests.TEST3, check);
+		assertEquals(msg, '');
+
+		msg = checkMessage(ReturnTests.TEST2, check);
+		assertEquals(msg, 'Return type not specified when returning a value for function: test1');
+	}
 }
 
 class ReturnTests {
@@ -39,4 +83,11 @@ class ReturnTests {
 			return;
 		}
 	}";
-}
+
+	public static inline var TEST4:String =
+	"class Test {
+		public function test3():Void {
+			return;
+		}
+	}";
+}

Original file line number	Diff line number	Diff line change
`@@ -104,13 +104,16 @@ More information in [wiki page](https://github.com/adireddy/haxe-checkstyle/wiki`
`104`	`104`	`{`
`105`	`105`	`"type": "PublicPrivate",`
`106`	`106`	`"props": {`
`107`		`- "severity": "INFO"`
	`107`	`+ "severity": "INFO",`
	`108`	`+ "enforcePublicPrivate": false`
`108`	`109`	`}`
`109`	`110`	`},`
`110`	`111`	`{`
`111`	`112`	`"type": "Return",`
`112`	`113`	`"props": {`
`113`		`- "severity": "INFO"`
	`114`	`+ "severity": "INFO",`
	`115`	`+ "allowEmptyReturn": true,`
	`116`	`+ "enforceReturnType": false`
`114`	`117`	`}`
`115`	`118`	`},`
`116`	`119`	`{`
`@@ -121,7 +124,6 @@ More information in [wiki page](https://github.com/adireddy/haxe-checkstyle/wiki`
`121`	`124`	`"spaceAroundBinop": true,`
`122`	`125`	`"spaceAroundBinop": true,`
`123`	`126`	`"ignoreRangeOperator": true`
`124`		`-`
`125`	`127`	`}`
`126`	`128`	`},`
`127`	`129`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "checkstyle",`
`3`		`- "version": "1.0.6",`
	`3`	`+ "version": "1.0.7",`
`4`	`4`	`"description": "Automated code analysis ideal for projects that want to enforce a coding standard.",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,8 @@`
`15`	`15`	`{`
`16`	`16`	`"type": "BlockFormat",`
`17`	`17`	`"props": {`
`18`		`- "severity": "ERROR"`
	`18`	`+ "severity": "ERROR",`
	`19`	`+ "emptyBlockCheck": false`
`19`	`20`	`}`
`20`	`21`	`},`
`21`	`22`	`{`