refactor: combine check and advance logic

The check(action) function in ComparisonSort has been deleted and all
checking logic happens in next(action) to reduce repeated code.

Author: danielzting

levels/bogo_sort.gd

@@ -12,10 +12,7 @@ Keep on hitting RIGHT ARROW to CONTINUE and hope for the best!
 func _init(array).(array):
     pass
 
-func check(action):
-    return true
-
-func next():
+func next(action):
     array = ArrayModel.new(array.size)
     if array.is_sorted():
         emit_signal("done")

levels/bubble_sort.gd

@@ -21,16 +21,14 @@ var _swapped = false
 func _init(array).(array):
     pass
 
-func check(action):
-    if array.get(_index) > array.get(_index + 1):
-        return action == ACTIONS.SWAP
-    else:
-        return action == ACTIONS.NO_SWAP
-
-func next():
+func next(action):
     if array.get(_index) > array.get(_index + 1):
+        if action != null and action != ACTIONS.SWAP:
+            return emit_signal("mistake")
         array.swap(_index, _index + 1)
         _swapped = true
+    elif action != null and action != ACTIONS.NO_SWAP:
+        return emit_signal("mistake")
     _index += 1
     if _index + 1 == _end:
         if not _swapped:

levels/comparison_sort.gd

@@ -4,19 +4,18 @@ extends Node
 signal done
 signal mistake
 
-enum ACTIONS {
-    SWAP,
-    NO_SWAP,
+const ACTIONS = {
+    "SWAP": "ui_left",
+    "NO_SWAP": "ui_right",
 
-    LEFT,
-    RIGHT,
+    "LEFT": "ui_left",
+    "RIGHT": "ui_right",
 }
 
 const EFFECTS = {
     "NONE": GlobalTheme.GREEN,
     "HIGHLIGHTED": GlobalTheme.ORANGE,
     "DIMMED": GlobalTheme.DARK_GREEN,
-    "WUT": 0,
 }
 
 const DISABLE_TIME = 1.0
@@ -38,20 +37,12 @@ func _input(event):
     """Pass input events for checking and take appropriate action."""
     if not active:
         return
-
-    for action in ACTIONS:
+    for action in ACTIONS.values():
         if event.is_action_pressed(action):
-            if check(ACTIONS[action]):
-                return next()
-    if event.is_pressed():
-        emit_signal("mistake")
-
-func check(action):
-    """Determine if the given action enum value is correct."""
-    push_error("NotImplementedError")
+            return next(action)
 
-func next():
-    """Advance the state by one step and signal done if completed."""
+func next(action):
+    """Check the action and advance state or emit signal as needed."""
     push_error("NotImplementedError")
 
 func _on_ComparisonSort_mistake():

levels/insertion_sort.gd

@@ -21,19 +21,17 @@ var _index = 1 # Position of element currently being inserted
 func _init(array).(array):
     pass
 
-func check(action):
-    if array.get(_index - 1) > array.get(_index):
-        return action == ACTIONS.SWAP
-    else:
-        return action == ACTIONS.NO_SWAP
-
-func next():
+func next(action):
     if array.get(_index - 1) > array.get(_index):
+        if action != null and action != ACTIONS.SWAP:
+            return emit_signal("mistake")
         array.swap(_index - 1, _index)
         _index -= 1
         if _index == 0:
             _grow()
     else:
+        if action != null and action != ACTIONS.NO_SWAP:
+            return emit_signal("mistake")
         _grow()
 
 func get_effect(i):

levels/selection_sort.gd

@@ -21,15 +21,13 @@ var _index = 1 # Index of tentative new smallest
 func _init(array).(array):
     pass
 
-func check(action):
-    if array.get(_base) > array.get(_index):
-        return action == ACTIONS.SWAP
-    else:
-        return action == ACTIONS.NO_SWAP
-
-func next():
+func next(action):
     if array.get(_base) > array.get(_index):
+        if action != null and action != ACTIONS.SWAP:
+            return emit_signal("mistake")
         array.swap(_base, _index)
+    elif action != null and action != ACTIONS.NO_SWAP:
+        return emit_signal("mistake")
     _index += 1
     if _index == array.size:
         _base += 1

scenes/levels.tscn

@@ -48,12 +48,6 @@ margin_bottom = 640.0
 rect_min_size = Vector2( 0, 640 )
 script = ExtResource( 3 )
 
-[node name="Placeholder" type="Control" parent="LevelSelect/Preview/Display"]
-margin_left = 20.0
-margin_top = 20.0
-margin_right = 1352.0
-margin_bottom = 620.0
-
 [node name="InfoBorder" type="MarginContainer" parent="LevelSelect/Preview"]
 margin_top = 648.0
 margin_right = 1372.0
@@ -73,7 +67,7 @@ margin_right = 810.0
 margin_bottom = 332.0
 rect_min_size = Vector2( 810, 0 )
 size_flags_vertical = 3
-text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse luctus lorem felis, in imperdiet mauris faucibus in. Vestibulum interdum mi at arcu congue congue. Cras sodales mauris odio, eget iaculis dolor tempor quis. Suspendisse nec iaculis sapien, eu sollicitudin orci. Nulla volutpat pellentesque ex nec cursus."
+text = "This is a short description of the algorithm. It should tell how it works in a simple yet complete way and explain its relevance in computer science. It should be accessible to the layman while not being oversimplifying."
 autowrap = true
 
 [node name="Controls" type="Label" parent="LevelSelect/Preview/InfoBorder/Info"]
@@ -83,10 +77,7 @@ margin_bottom = 332.0
 rect_min_size = Vector2( 450, 0 )
 size_flags_horizontal = 3
 size_flags_vertical = 3
-text = "INSTRUCTIONS
-
-LEFT ARROW: SWAP
-RIGHT ARROW: CONTINUE"
+text = "These are the controls for the level. They should be tailored to each level for maximum efficiency and simplicity."
 autowrap = true
 
 [node name="Timer" type="Timer" parent="."]

scripts/levels.gd

@@ -51,7 +51,7 @@ func get_level(name):
             return level
 
 func _on_Timer_timeout():
-    level.next()
+    level.next(null)
 
 func _cleanup(string):
     return string.strip_edges().replace("\n", " ")

scripts/menu.gd

@@ -15,4 +15,4 @@ func _on_Credits_pressed():
     GlobalScene.change_scene("res://scenes/credits.tscn")
 
 func _on_Timer_timeout():
-    level.next()
+    level.next(null)