oops

Author: ryunp

README.md

@@ -3,7 +3,37 @@
 
 Despite AutoHotKey (1.1.28 at the moment) supporting Arrays and Function Objects, there are no handy built-in methods for parsing Array data. This project ports most of JavaScript's Array object methods over to AutoHotKey.
 
+<<<<<<< HEAD
 ### Ported Methods
+=======
+AHK supports [objects](https://autohotkey.com/docs/objects/Object.htm), [arrays](https://autohotkey.com/docs/Objects.htm#Table_of_Contents), and [function objects](https://autohotkey.com/docs/objects/Functor.htm). But it lacks built in methods for functional operation on arrays, like `Array.map()`. JavaScript's Array object has some handy methods; so I ported them over.
+
+Since AHK is also prototypical in nature, these could have been added to a base object. For simplicity's sake these are global functions. All methods are prefixed with `array_`.
+
+### Usage
+
+Just include the `array_.ahk` file and pass functors as arguments when needed. For instance, to double all values in an array:
+
+    array := [1,2,3,4]
+    result := array_map(array, func("double"))
+    double(item) {
+    	return item * 2
+    }
+    msgbox % array_toString(result) ;outputs "[2,4,6,8]"
+
+or getting fancy with a partial:
+
+    array := [12,3,44,9]
+    result := array_map(array, func("multiply").bind(2))
+    multiply(a, b) {
+    	return a * b
+    }
+    msgbox % array_toString(result) ;outputs "[24,6,88,18]"
+    
+
+### Stolen Methods
+
+>>>>>>> origin/master
 * concat
 * every
 * fill
@@ -27,7 +57,10 @@ Despite AutoHotKey (1.1.28 at the moment) supporting Arrays and Function Objects
 * toString
 * unshift
 
+### Sort?
+Considered implementing a `array_sort` quicksort; but currently no immediate need.
 
+<<<<<<< HEAD
 ### Installation
 There are two options for using importing these functions, either as global functions stored in **array_.ahk** or by extending the built-in Array object stored in **array_base.ahk**. The sorting function in both files depends on the object defined in **array_quicksort.ahk**. This object must be present for sorting to work properly.
 
@@ -122,3 +155,31 @@ Class Array_QuickSort {
 A quick and dirty test suite was crafted to make sure these were functioning properly. Each function/method has a test case in the **/tests/** directory. The test runner UI has two tabs representing each library's test results:
 
 ![Tester Results Screenshot](tester/ui_preview.png)
+=======
+### Tests
+Nothing is truely complete without testing, so each `array_<method>` has a test case file in the `tests/` directory.
+
+Built a few primitive [test classes](test_suite/tester.ahk) to collect test cases. Management of this test class is located in [testrunner.ahk](testrunner.ahk). Results are output to an edit control in a new window.
+
+Sample of [test runner results](testrunner_results.txt):
+
+    01/22/17 - 19:23:53
+    -Conversion of JavaScript's Array methods to AutoHotkey-
+    
+    array_some(array, callback)
+    [PASS] Detect one even number
+    [PASS] Detect one odd number
+    [PASS] Fails to find large enough number
+    
+    array_splice(ByRef array, start, deleteCount:=-1, args*)
+    [PASS] Starting position only: array
+    [PASS] Starting position only: spliced
+    [PASS] Starting position with delete: array
+    [PASS] Starting position with delete: spliced
+    [PASS] Starting position no delete: array
+    [PASS] Starting position no delete: spliced
+    [PASS] Starting position with delete and args: array
+    [PASS] Starting position with delete and args: spliced
+    [PASS] Starting position no delete and args: array
+    [PASS] Starting position no delete and args: spliced
+>>>>>>> origin/master

array_.ahk

@@ -47,8 +47,11 @@ array_fill(array, value, start:=0, end:=0) {
 
 	loop, % (last - begin)
 		array[begin + A_Index] := value
+<<<<<<< HEAD
 
 	return array
+=======
+>>>>>>> origin/master
 }
 
 
@@ -167,7 +170,11 @@ array_lastIndexOf(array, searchElement, fromIndex:=0) {
 
 ; https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map
 array_map(array, callback) {
+<<<<<<< HEAD
     global
+=======
+
+>>>>>>> origin/master
 	results := []
 
 	for index, element in array
@@ -181,10 +188,18 @@ array_map(array, callback) {
 ; -->[A,B,C,D,E,F]
 array_reduce(array, callback, initialValue:="__NULL__") {
 
+<<<<<<< HEAD
 	arrLen := array.Length()
 
 	; initialValue not defined
 	if (initialValue == "__NULL__") {
+=======
+	idxOffset := 0
+	arrLen := array.Length()
+
+	; No initialValue passed
+	if (initialValue == "IAMNULL") {
+>>>>>>> origin/master
 
 		if (arrLen < 1) {
 			; Empty array with no intial value
@@ -194,6 +209,7 @@ array_reduce(array, callback, initialValue:="__NULL__") {
 			; Single item array with no initial value
 			return array[1]
 		}
+<<<<<<< HEAD
 
 		; Starting value is last element
 		initialValue := array[1]
@@ -203,6 +219,12 @@ array_reduce(array, callback, initialValue:="__NULL__") {
 
 		; Set index A_Index+1 each iteration
 		idxOffset := 1
+=======
+		else {
+			idxOffset := 1
+			initialValue := array[1]
+		}
+>>>>>>> origin/master
 
 	} else {
 	; initialValue defined
@@ -219,10 +241,17 @@ array_reduce(array, callback, initialValue:="__NULL__") {
 		idxOffset := 0
 	}
 
+<<<<<<< HEAD
 	; if no initialValue is passed, use first index as starting value and reduce
 	; array starting at index n+1. Otherwise, use initialValue as staring value
 	; and start at arrays first index.
 	Loop, % iterations
+=======
+	; if no initialValue is passed, reduce passed array starting at second
+	; index. Otherwise use initialValue as reduction target and start at array's
+	; first index.
+	Loop, % (arrLen - idxOffset)
+>>>>>>> origin/master
 	{
 		adjIndex := A_Index + idxOffset
 		initialValue := callback.Call(initialValue, array[adjIndex], adjIndex, array)
@@ -238,6 +267,7 @@ array_reduceRight(array, callback, initialValue:="__NULL__") {
 
 	arrLen := array.Length()
 
+<<<<<<< HEAD
 	; initialValue not defined
 	if (initialValue == "__NULL__") {
 
@@ -247,16 +277,34 @@ array_reduceRight(array, callback, initialValue:="__NULL__") {
 		}
 		else if (arrLen == 1) {
 			; Single item array with no initial value
+=======
+	; No initialValue passed
+	if (initialValue == "IAMNULL") {
+
+		if (arrLen < 1)
+			throw "Empty array with no intial value, derp"
+		else if (arrLen == 1)
+>>>>>>> origin/master
 			return array[1]
 		}
 
+<<<<<<< HEAD
 		; Starting value is last element
 		initialValue := array[arrLen]
 
 		; Loop n-1 times (starting at n-1 element)
 		iterations := arrLen - 1 
 
 		; Set index A_Index-1 each iteration
+=======
+		; Start at end
+		initialValue := array[arrLen]
+
+		; Loop n-1 times (start at n-1 element)
+		iterations := arrLen - 1 
+		
+		; Start at n-1 element (Keep 1 based index notation)
+>>>>>>> origin/master
 		idxOffset := 0
 
 	} else {
@@ -269,13 +317,20 @@ array_reduceRight(array, callback, initialValue:="__NULL__") {
 		; Loop n times (start at n element)
 		iterations := arrLen
 
+<<<<<<< HEAD
 		; Set index A_Index each iteration
 		idxOffset := 1
 	}
 
 	; If no initialValue is passed, use last index as starting value and reduce
 	; array starting at index n-1. Otherwise, use initialValue as starting value
 	; and start at arrays last index.
+=======
+		; Start at n element (Adjust to 0 based index notation)
+		idxOffset := 1
+	}
+
+>>>>>>> origin/master
 	Loop, % iterations
 	{
 		adjIndex := arrLen - (A_Index - idxOffset)
@@ -359,8 +414,13 @@ array_some(array, callback) {
 ; https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort
 array_sort(array, compare_fn:=0) {
 
+<<<<<<< HEAD
     ; Quicksort
 	Array_QuickSort.Call(array, compare_fn)
+=======
+	;Quicksort
+	throw "Not implemented"
+>>>>>>> origin/master
 
     return array
 }
@@ -407,12 +467,11 @@ array_splice(ByRef array, start, deleteCount:=-1, args*) {
 ; https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/toString
 array_toString(array) {
 
-	str := "["
-
+	str := ""
 	for i,v in array
-		str .= v (i < array.Length() ? ", " : "")
+		str .= v (i < array.Length() ? "," : "")
 
-	return str "]"
+	return "[" str "]"
 }
 
 

test_suite/example.png

@@ -0,0 +1,65 @@
+class TestRunner {
+
+	groups := []
+
+	__New(title) {
+		this.title := title
+	}
+
+	newGroup(title) {
+
+		tests := new TestGroup(title)
+		this.groups.push(tests)
+
+		return tests
+	}
+
+	getAllTestResults() {
+
+		FormatTime, CurrentDateTime,, MM/dd/yy - HH:mm:ss
+		results := [CurrentDateTime, this.title, ""]
+
+		for i, tests in this.groups
+			results.push(tests.getTestResults())
+
+		return array_join(results, "`n")
+	}
+}
+
+
+class TestGroup {
+
+	tests := []
+
+	__New(title) {
+		this.title := title
+	}
+
+	newTest(desc, result) {
+
+		this.tests.push(new Test(desc, result))
+	}
+
+	getTestResults() {
+
+		results := [this.title]
+
+		for i, test in this.tests
+			results.push(test.getResult())
+		
+		return array_join(results, "`n") "`n"
+	}
+}
+
+class Test {
+
+	__New(desc, result) {
+		this.desc := desc
+		this.result := result
+	}
+
+	getResult() {
+
+		return "[" (this.result ? "PASS" : "----") "] " this.desc
+	}
+}

test_suite/tester.ahk

@@ -37,8 +37,10 @@ tester := new TestRunner("-explicit array_<fn> functions from 'array_.ahk'-")
 #Include, array_some.test.ahk
 #Include, array_sort.test.ahk
 #Include, array_splice.test.ahk
+#Include, array_toString.test.ahk
 #Include, array_unshift.test.ahk
 
+<<<<<<< HEAD
 ; Setup 'array_' results
 Gui, Tab, array_
 gui, add, edit, r30 w375, % tester.getAllTestResults()
@@ -83,6 +85,10 @@ gui, add, edit, r30 w375, % tester.getAllTestResults()
 
 
 ; Show Gui
+=======
+; Show results
+gui, add, edit, r30, % tester.getAllTestResults()
+>>>>>>> origin/master
 gui, show
 
 return