change getLinePos from O(n/2) to O(log(N)) (#439)

AlexHaxe · web-flow · commit d9a849c90bc1 · 2018-06-17T19:38:17.000+02:00
* change getLinePos from O(n/2) to O(log(N))
* refactor gruntfile
* added hxnodejs to travisCI
diff --git a/.travis.yml b/.travis.yml
@@ -15,6 +15,7 @@ matrix:
     - haxe: 3.4.7
       install:
         - haxelib git tokentree https://github.com/HaxeCheckstyle/tokentree master src
+        - haxelib git hxnodejs https://github.com/HaxeFoundation/hxnodejs.git master
         - haxelib install haxeparser 3.3.0
         - haxelib install compiletime 2.6.0
         - haxelib install hxargs 3.0.2
@@ -26,6 +27,7 @@ matrix:
         - haxelib git hxparse https://github.com/simn/hxparse
         - haxelib git haxeparser https://github.com/simn/haxeparser
         - haxelib git mcover https://github.com/massiveinteractive/mcover master src
+        - haxelib git hxnodejs https://github.com/HaxeFoundation/hxnodejs.git master
         - haxelib install mconsole
         - haxelib install compiletime 2.6.0
         - haxelib install hxargs 3.0.2
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,7 @@
 ## dev branch / next version (2.x.x)
 
+- Refactored `Checker.getLinePos` to use binary search, reduces runtime from O(N/2) to O(log N) [#439](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/439)
+
 ## version 2.4.1 (2018-06-14)
 
 - Added JSON schemas for `checkstyle.json` and `checkstyle-exclude.json` file formats [#431](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/431) +  [#432](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/432) + [#433](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/433)
diff --git a/buildAll.hxml b/buildAll.hxml
@@ -6,6 +6,10 @@ buildDebug.hxml
 
 --next
 
+buildJS.hxml
+
+--next
+
 buildSchema.hxml
 
 --next
diff --git a/gruntfile.js b/gruntfile.js
@@ -12,16 +12,8 @@ module.exports = function(grunt) {
                     "haxelib install tokentree"
             }
         },
-
         haxe: haxeOptions(),
-
-        zip: {
-            "haxe-checkstyle.zip": [
-                "src/**",
-                "resources/sample-config.json", "resources/logo.png", "resources/codeclimate_pr.png",
-                "haxelib.json", "run.n", "README.md", "CHANGES.md"
-            ]
-        }
+        zip: zipIt()
     });
 
     grunt.loadNpmTasks("grunt-haxe");
@@ -48,4 +40,18 @@ function haxeOptions() {
             hxml: "buildTelemetry.hxml"
         }
     };
+}
+
+function zipIt() {
+    return {
+        release: {
+            src: [
+                "src/**",
+                "resources/sample-config.json", "resources/logo.png", "resources/codeclimate_pr.png",
+                "haxelib.json", "run.n", "README.md", "CHANGES.md", "LICENCE.md"
+            ],
+            dest: "haxe-checkstyle.zip",
+            compression: "DEFLATE",
+        }
+    };
 }
diff --git a/src/checkstyle/Checker.hx b/src/checkstyle/Checker.hx
@@ -14,6 +14,7 @@ import checkstyle.reporter.ReporterManager;
 import tokentree.TokenTreeBuilder;
 
 class Checker {
+	static inline var BAD_OFFSET:String = "Bad offset";
 
 	public var file:CheckFile;
 	public var lines:Array<String>;
@@ -33,6 +34,7 @@ class Checker {
 		checks = [];
 		baseDefines = [];
 		defineCombinations = [];
+		linesIdx = [];
 	}
 
 	public function addCheck(check:Check) {
@@ -64,10 +66,27 @@ class Checker {
 	}
 
 	public function getLinePos(off:Int):LinePos {
-		for (i in 0...linesIdx.length) {
-			if (linesIdx[i].l <= off && linesIdx[i].r >= off) return { line:i, ofs: off - linesIdx[i].l };
+		var lowerBound:Int = 0;
+		var upperBound:Int = linesIdx.length - 1;
+		if (linesIdx.length <= 0) throw BAD_OFFSET;
+		if (off < 0) throw BAD_OFFSET;
+		if (off > linesIdx[upperBound].r) throw BAD_OFFSET;
+		while (true) {
+			if (lowerBound > upperBound) throw BAD_OFFSET;
+			var center:Int = lowerBound + Math.floor((upperBound - lowerBound) / 2);
+			var matchLeft:Bool = linesIdx[center].l <= off;
+			var matchRight:Bool = linesIdx[center].r >= off;
+			if (matchLeft && matchRight) return { line: center, ofs: off - linesIdx[center].l };
+			if (matchLeft) {
+				lowerBound = center + 1;
+				continue;
+			}
+			if (matchRight) {
+				upperBound = center - 1;
+				continue;
+			}
 		}
-		throw "Bad offset";
+		throw BAD_OFFSET;
 	}
 
 	public function getString(off:Int, off2:Int):String {
diff --git a/test/TestSuite.hx b/test/TestSuite.hx
@@ -1,10 +1,11 @@
 import checks.CheckTestCase;
+import config.ConfigParserTest;
+import config.ExcludeManagerTest;
 import detect.DetectCodingStyleTest;
+import misc.CheckerTest;
 #if !eval
 import misc.ThreadTest;
 #end
-import config.ConfigParserTest;
-import config.ExcludeManagerTest;
 
 class TestSuite extends massive.munit.TestSuite {
 
@@ -14,6 +15,7 @@ class TestSuite extends massive.munit.TestSuite {
 		CompileTime.importPackage("checks");
 		CompileTime.importPackage("misc");
 
+		add(CheckerTest);
 		add(ConfigParserTest);
 		add(ExcludeManagerTest);
 		add(DetectCodingStyleTest);
diff --git a/test/checks/CheckTestCase.hx b/test/checks/CheckTestCase.hx
@@ -2,17 +2,13 @@ package checks;
 
 import byte.ByteData;
 
-import haxe.PosInfos;
-
 import checkstyle.CheckMessage;
 import checkstyle.CheckFile;
 import checkstyle.reporter.IReporter;
 import checkstyle.reporter.ReporterManager;
 import checkstyle.Checker;
 import checkstyle.checks.Check;
 
-import massive.munit.Assert;
-
 class CheckTestCase<T:String> {
 
 	static inline var FILE_NAME:String = "Test.hx";
diff --git a/test/config/ConfigParserTest.hx b/test/config/ConfigParserTest.hx
@@ -1,7 +1,5 @@
 package config;
 
-import massive.munit.Assert;
-
 import checkstyle.config.Config;
 import checkstyle.config.ConfigParser;
 import checkstyle.utils.ConfigUtils;
diff --git a/test/config/ExcludeManagerTest.hx b/test/config/ExcludeManagerTest.hx
@@ -1,7 +1,5 @@
 package config;
 
-import massive.munit.Assert;
-
 import checkstyle.checks.type.DynamicCheck;
 import checkstyle.checks.type.ReturnCheck;
 
diff --git a/test/detect/DetectCodingStyleTest.hx b/test/detect/DetectCodingStyleTest.hx
@@ -53,8 +53,6 @@ import checkstyle.checks.whitespace.WhitespaceCheckBase.WhitespacePolicy;
 import checkstyle.checks.whitespace.WrapCheckBase.WrapCheckBaseOption;
 import checkstyle.detect.DetectCodingStyle;
 
-import massive.munit.Assert;
-
 class DetectCodingStyleTest {
 
 	// checkstyle.checks.block
diff --git a/test/import.hx b/test/import.hx
@@ -0,0 +1,3 @@
+import haxe.PosInfos;
+
+import massive.munit.Assert;
diff --git a/test/misc/CheckerTest.hx b/test/misc/CheckerTest.hx
@@ -0,0 +1,71 @@
+package misc;
+
+import checkstyle.Checker;
+
+class CheckerTest {
+
+	@Test
+	public function testEmptyLinesIdx() {
+		var checker:Checker = new Checker();
+
+		throwsBadOffset(checker, 0);
+		throwsBadOffset(checker, 100);
+		throwsBadOffset(checker, -100);
+	}
+
+	@Test
+	public function testOneLinesIdx() {
+		var checker:Checker = new Checker();
+		checker.linesIdx.push({l: 0, r: 100});
+
+		checkLinePos(checker, 0, 0, 0);
+		checkLinePos(checker, 50, 0, 50);
+		checkLinePos(checker, 100, 0, 100);
+		throwsBadOffset(checker, 101);
+		throwsBadOffset(checker, -100);
+	}
+
+	@Test
+	public function testMultipleLinesIdx() {
+		var checker:Checker = new Checker();
+		checker.linesIdx.push({l: 0, r: 100});
+		checker.linesIdx.push({l: 101, r: 200});
+		checker.linesIdx.push({l: 201, r: 300});
+		checker.linesIdx.push({l: 301, r: 400});
+		checker.linesIdx.push({l: 401, r: 500});
+		checker.linesIdx.push({l: 501, r: 600});
+		checker.linesIdx.push({l: 601, r: 700});
+		checker.linesIdx.push({l: 701, r: 800});
+
+		checkLinePos(checker, 0, 0, 0);
+		checkLinePos(checker, 50, 0, 50);
+		checkLinePos(checker, 100, 0, 100);
+		checkLinePos(checker, 150, 1, 49);
+		checkLinePos(checker, 250, 2, 49);
+		checkLinePos(checker, 350, 3, 49);
+		checkLinePos(checker, 450, 4, 49);
+		checkLinePos(checker, 550, 5, 49);
+		checkLinePos(checker, 650, 6, 49);
+		checkLinePos(checker, 750, 7, 49);
+		throwsBadOffset(checker, 801);
+		throwsBadOffset(checker, -100);
+	}
+
+	function checkLinePos(checker:Checker, ofs:Int, expectedLine:Int, expectedOfs:Int, ?pos:PosInfos) {
+		var linePos:LinePos = checker.getLinePos(ofs);
+
+		Assert.isNotNull(linePos, pos);
+		Assert.areEqual(expectedLine, linePos.line, pos);
+		Assert.areEqual(expectedOfs, linePos.ofs, pos);
+	}
+
+	function throwsBadOffset(checker:Checker, ofs:Int, ?pos:PosInfos) {
+		try {
+			checker.getLinePos(ofs);
+			Assert.fail("line pos calculation should fail", pos);
+		}
+		catch (e:Any) {
+			Assert.areEqual("Bad offset", '$e', pos);
+		}
+	}
+}
diff --git a/test/misc/ThreadTest.hx b/test/misc/ThreadTest.hx
@@ -12,8 +12,6 @@ import checks.whitespace.IndentationCheckTest.IndentationCheckTests;
 
 import checks.CheckTestCase.TestReporter;
 
-import massive.munit.Assert;
-
 class ThreadTest {
 
 	static inline var FILE_NAME:String = "Test.hx";
