refactor: move levels.json data into classes

The codebase has been refactored so that each level contains its own
title and description, removing the need for a separate levels.json
file.

Author: danielzting

assets/levels.json

@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="StreamTexture"
+path="res://.import/levels.png-a6e910382d32e95b5c3f382bb559bde4.stex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://assets/levels.png"
+dest_files=[ "res://.import/levels.png-a6e910382d32e95b5c3f382bb559bde4.stex" ]
+
+[params]
+
+compress/mode=0
+compress/lossy_quality=0.7
+compress/hdr_mode=0
+compress/bptc_ldr=0
+compress/normal_map=0
+flags/repeat=0
+flags/filter=true
+flags/mipmaps=false
+flags/anisotropic=false
+flags/srgb=2
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/HDR_as_SRGB=false
+process/invert_color=false
+stream=false
+size_limit=0
+detect_3d=true
+svg/scale=1.0

assets/levels.png.import

@@ -1,14 +1,18 @@
 extends ComparisonSort
 class_name BogoSort
 
+const TITLE = "BOGOSORT"
+const ABOUT = """Generates random permutations until the array is
+sorted."""
+
 func _init(array).(array):
-	pass
+    pass
 
 func check(action):
-	return true
+    return true
 
 func next():
-	array = ArrayModel.new(array.size)
+    array = ArrayModel.new(array.size)
 
 func emphasized(i):
-	return false
+    return false

levels/bogo_sort.gd

@@ -1,27 +1,33 @@
 extends ComparisonSort
 class_name BubbleSort
 
+const TITLE = "BUBBLE SORT"
+const ABOUT = """Bubble sort iterates through the array and looks at
+each pair of elements, swapping them if they are out of order. When it
+has gone through the entire array without swapping a single pair, it has
+finished. Though simple to understand, bubble sort is hopelessly
+inefficient on all but the smallest of arrays."""
 var swapped = false
 
 func _init(array).(array):
-	pass
+    pass
 
 func check(action):
-	if array.get(index) > array.get(index + 1):
-		return action == "swap"
-	else:
-		return action == "no_swap"
+    if array.get(index) > array.get(index + 1):
+        return action == "swap"
+    else:
+        return action == "no_swap"
 
 func next():
-	if array.get(index) > array.get(index + 1):
-		array.swap(index, index + 1)
-		swapped = true
-	index += 1
-	if index == array.size - 1:
-		if not swapped:
-			emit_signal("done")
-		index = 0
-		swapped = false
+    if array.get(index) > array.get(index + 1):
+        array.swap(index, index + 1)
+        swapped = true
+    index += 1
+    if index == array.size - 1:
+        if not swapped:
+            emit_signal("done")
+        index = 0
+        swapped = false
 
 func emphasized(i):
-	return i == index or i == index + 1
+    return i == index or i == index + 1

levels/bubble_sort.gd

@@ -12,32 +12,32 @@ var timer = Timer.new()
 var active = true
 
 func _init(array):
-	self.array = array
-	timer.one_shot = true
-	timer.connect("timeout", self, "_on_Timer_timeout")
-	add_child(timer)
-	self.connect("mistake", self, "_on_ComparisonSort_mistake")
+    self.array = array
+    timer.one_shot = true
+    timer.connect("timeout", self, "_on_Timer_timeout")
+    add_child(timer)
+    self.connect("mistake", self, "_on_ComparisonSort_mistake")
 
 func check(action):
-	pass
+    pass
 
 func next():
-	pass
+    pass
 
 func _on_ComparisonSort_mistake():
-	active = false
-	timer.start(1)
+    active = false
+    timer.start(1)
 
 func _on_Timer_timeout():
-	active = true
+    active = true
 
 func _input(event):
-	if not active:
-		return
-
-	for action in ACTIONS:
-		if event.is_action_pressed(action):
-			if check(action):
-				next()
-			else:
-				emit_signal("mistake")
+    if not active:
+        return
+
+    for action in ACTIONS:
+        if event.is_action_pressed(action):
+            if check(action):
+                next()
+            else:
+                emit_signal("mistake")

levels/comparison_sort.gd

@@ -1,44 +1,40 @@
 extends HBoxContainer
 
-var levels: Dictionary
-var level
+var levels = [
+    BubbleSort,
+]
+var level: ComparisonSort
 
 func _ready():
-    # Load level data
-    var descriptions = File.new()
-    descriptions.open("res://assets/levels.json", File.READ)
-    levels = parse_json(descriptions.get_as_text())
-    # Dynamically add buttons
+    # Dynamically load level data
     for level in levels:
         var button = Button.new()
-        button.text = level
+        button.text = level.TITLE
         button.align = Button.ALIGN_LEFT
         button.connect("focus_entered", self, "_on_Button_focus_changed")
-        button.connect("pressed", self, "_on_Button_pressed", [level])
+        button.connect("pressed", self, "_on_Button_pressed", [level.TITLE])
         $LevelsBorder/Levels.add_child(button)
     # Automatically focus on first button
     $LevelsBorder/Levels.get_child(0).grab_focus()
 
 func _on_Button_focus_changed():
-    var name = get_focus_owner().text
-    $Preview/InfoBorder/Info/Description.text = levels[name]["about"]
-    level = get_level(name).new(ArrayModel.new(10))
+    level = get_level(get_focus_owner().text).new(ArrayModel.new(10))
     level.active = false
+    $Preview/InfoBorder/Info/Description.text = level.ABOUT.replace("\n", " ")
     # Start over when simulation is finished
     level.connect("done", self, "_on_Button_focus_changed")
     # Replace old display with new
     for child in $Preview/Display.get_children():
         child.queue_free()
     $Preview/Display.add_child(ArrayView.new(level))
 
-func _on_Button_pressed(level):
-    scene.change_scene("res://scenes/play.tscn",
-                      {"name": level, "level": get_level(level)})
+func _on_Button_pressed(title):
+    scene.change_scene("res://scenes/play.tscn", {"level": get_level(title)})
 
-func get_level(level):
-    match level:
-        "BUBBLE SORT":
-            return BubbleSort
+func get_level(title):
+    for level in levels:
+        if level.TITLE == title:
+            return level
 
 func _on_Timer_timeout():
     level.next()

scripts/levels.gd

@@ -3,7 +3,7 @@ extends VBoxContainer
 var start_time = -1
 
 func _ready():
-    $HUDBorder/HUD/Level.text = scene.get_param("name")
+    $HUDBorder/HUD/Level.text = scene.get_param("level").TITLE
 
 func _process(delta):
     if start_time >= 0:
@@ -14,8 +14,7 @@ func _on_Timer_timeout():
     # Delete ready text
     $DisplayBorder/Label.queue_free()
     # Load level
-    var array = ArrayModel.new(10)
-    var level = scene.get_param("level").new(array)
+    var level = scene.get_param("level").new(ArrayModel.new(10))
     level.connect("done", self, "_on_Level_done")
     $DisplayBorder.add_child(ArrayView.new(level))
 

scripts/play.gd

@@ -4,7 +4,7 @@ class_name ArrayView
 const GREEN = Color(0.2, 1, 0.2)
 const ORANGE = Color(1, 0.69, 0)
 
-var level
+var level: ComparisonSort
 var rects = []
 
 func _init(level):