feat: clearArea Integration

Author: ChristophLHR

builder-lib.lua

@@ -41,23 +41,20 @@ local function getTurningDirection(builderRef ,cHorizontal, cVertical, maxWidth)
     cHorizontal = cHorizontal or 1
     cVertical = cVertical or 1
     maxWidth = maxWidth or 2 -- default is even
-    local even = maxWidth % 2
+
     local hModulo = cHorizontal % 2
     local vModulo = cVertical % 2
-    if builderRef.movementDirection.width == "right" then
-        hModulo = 1 - hModulo -- toggle between 1 / 0
+    
+    -- if odd, pretent to always be at base y-level and CONTINUE the left / right toggle
+    -- making vModulo static
+    if (maxWidth % 2 == 1) then
+        vModulo = 1
     end
 
-    -- TODO Simplify
-    -- with vModulo == hModulo xor even
-    if (even == 1 and vModulo == 0) then
-        if (hModulo ~= vModulo) then
-            turtle.turnRight()
-        else
-            turtle.turnLeft()
-        end
-        return
+    if builderRef.movementDirection.width == "left" then
+        hModulo = 1 - hModulo -- invert 1 <=> 0
     end
+
     if (hModulo == vModulo) then
         turtle.turnRight()
     else
@@ -71,8 +68,9 @@ local function returnToStartingPos()
 end
 
 ---builds the floor with the given size
----@param length number
----@param width number
+---@param length number | nil
+---@param width number | nil
+---@return boolean success
 function Builder_Lib:floor(length, width)
     length = length or 1
     width = width or 1
@@ -92,17 +90,37 @@ function Builder_Lib:floor(length, width)
         end
     end
     returnToStartingPos()
+    return true
 end
 
+---clears an area with of specified size
+---@param length number | nil
+---@param width number | nil
+---@param height number | nil
+---@return boolean success
 function Builder_Lib:clearArea(length, width, height)
     local upDownDig = function(cHeight, maxHeight)
-        if(cHeight < maxHeight) then
-            turtleController:tryAction("digU")
-        end
-        if(cHeight > 1) then
-            turtleController:tryAction("digD")
+        if Builder_Lib.movementDirection.height == "up" then
+            if(cHeight < maxHeight) then
+                turtleController:tryAction("digU")
+            end
+            if(cHeight > 1) then
+                turtleController:tryAction("digD")
+            end
+        else
+            if(cHeight < maxHeight) then
+                turtleController:tryAction("digD")
+            end
+            if(cHeight > 1) then
+                turtleController:tryAction("digU")
+            end
         end
     end
+    length = length or 1
+    width = width or 1
+    height = height or 1
+
+
     local currentHeight = 1
     local k = 1
     while true do 
@@ -116,6 +134,7 @@ function Builder_Lib:clearArea(length, width, height)
                 getTurningDirection(self, j, k, width)
                 turtleController:goStraight(1)
                 getTurningDirection(self, j, k, width)
+            else
             end
         end
         upDownDig(currentHeight, height)
@@ -125,7 +144,7 @@ function Builder_Lib:clearArea(length, width, height)
         if diff > 3 then 
             diff = 3
         end
-        if diff == 0 then
+        if diff <= 1 then
             break
         end
         if self.movementDirection.height == "up" then
@@ -140,5 +159,6 @@ function Builder_Lib:clearArea(length, width, height)
     end
 
     returnToStartingPos()
+    return true
 end
 return Builder_Lib

builder.lua

@@ -7,15 +7,16 @@ local builder = require("builder-lib")
 local function help()
     print("Usage:")
     print("builder <command> <options>")
-    print("")
     print("Commands: ")
-    print("- 'floor'")
-    print("")
+    print("'floor'")
+    print("'clearArea'")
     print("Options:")
-    print("-m[movementDirection] <'left'|'right'> [default: right]")
+    print("-mH[movementDir. Horizon] <'left'|'right'> [default: right]")
+    print("-mV[movementDir. Vertical] <'left'|'right'> [default: right]")
     print("-w[width] <number>")
     print("-l[length] <number>")
-    print("-h[help]")
+    print("-h[height] <number>")
+    print("-help")
 end
 if #arg == 0 then
     help()
@@ -26,16 +27,20 @@ end
 local stopExec = false
 
 local size = {
-    ["length"] = 0,
-    ["width"] = 0,
-    ["height"] = 0
+    ["length"] = nil,
+    ["width"] = nil,
+    ["height"] = nil
 }
 
 local argsSwitch = {
-    ["-m"] = function(no)
+    ["-mH"] = function(no)
         no[1] = no[1] + 1
         builder.movementDirection.width = arg[no[1]]
     end,
+    ["-mV"] = function (no)
+        no[1] = no[1] + 1
+        builder.movementDirection.height = arg[no[1]]
+    end,
     ["-l"] = function(no)
         no[1] = no[1] + 1
         size["length"] = tonumber(arg[no[1]]) or error("length not valid")
@@ -44,7 +49,16 @@ local argsSwitch = {
         no[1] = no[1] + 1
         size["width"] = tonumber(arg[no[1]]) or error("width not valid")
     end,
-    ["-h"] = function()
+    ["-h"] = function(no)
+        no[1] = no[1] + 1
+        if not tonumber(arg[no[1]]) then
+            help()
+            stopExec = true
+            return
+        end
+        size["height"] = tonumber(arg[no[1]])
+    end,
+    ["-help"] = function()
         help()
         stopExec = true
     end,
@@ -56,6 +70,9 @@ local argsSwitch = {
 local commands = {
     ["floor"] = function()
         builder:floor(size["length"], size["width"])
+    end,
+    ["clearArea"] = function()
+        builder:clearArea(size["length"], size["width"], size["height"])
     end
 }
 

tests/clearArea_spec.lua

@@ -151,10 +151,12 @@ describe("Testing ClearArea Function", function()
         assert(998, countTableLength(turtleEmulator.blocks))
     end)
 
-    it("Clear 4 x 4 x 4 | Moving: left up", function()
+    it("Clear 4 x 4 x 4 | Moving: right up", function()
         -- pending("pending")
         builder.movementDirection.height = "up"
-        builder.movementDirection.width = "left"
+        builder.movementDirection.width = "right"
+
+        
         builder:clearArea(4,4,4)
 
         local n = countTableLength(turtleEmulator.blocks)
@@ -163,16 +165,17 @@ describe("Testing ClearArea Function", function()
         assert.are.equal(0,m)
     end)
 
-    it("Clear 4 x 4 x 4 | Moving: right up", function()
+    it("Clear 4 x 4 x 4 | Moving: left up", function()
         -- pending("pending")
         builder.movementDirection.height = "up"
-        builder.movementDirection.width = "right"
+        builder.movementDirection.width = "left"
+        
         ---position turtle at 0, 0, 3
         turtle.position = vector.new(-1, 0, 3)
         turtle.refuel()
         turtle.dig()
         assert.is_true(turtle.forward())
-        
+
         builder:clearArea(4,4,4)
 
         local n = countTableLength(turtleEmulator.blocks)
@@ -181,10 +184,10 @@ describe("Testing ClearArea Function", function()
         assert.are.equal(0,m)
     end)
 
-        it("Clear 5 x 5 x 5 | Moving: left down", function()
-        pending("pending")
+    it("Clear 5 x 5 x 5 | Moving: right down", function()
+        -- pending("pending")
         builder.movementDirection.height = "down"
-        builder.movementDirection.width = "left"
+        builder.movementDirection.width = "right"
 
         ---position turtle at 0, 4, 0
         turtle.position = vector.new(-1, 4, 0)
@@ -197,7 +200,26 @@ describe("Testing ClearArea Function", function()
         local n = countTableLength(turtleEmulator.blocks)
         assert(998 - (5*5*5), n)
         local m, blocks = checkEmptyFromTo(vector.new(0,0,0),vector.new(4,4,4))
-        print(textutils.serialize(blocks))
         assert.are.equal(0,m)
     end)
+
+    it("Clear 5 x 5 x 5 | Moving: left down", function()
+        -- pending("pending")
+        builder.movementDirection.height = "down"
+        builder.movementDirection.width = "left"
+        
+        ---position turtle at 0, 4, 0
+        turtle.position = vector.new(-1, 4, 4)
+        turtle.refuel()
+        turtle.dig()
+        assert.is_true(turtle.forward())
+
+        builder:clearArea(5,5,5)
+
+        local n = countTableLength(turtleEmulator.blocks)
+        assert(998 - (5*5*5), n)
+        local m, blocks = checkEmptyFromTo(vector.new(0,0,0),vector.new(4,4,4))
+        assert.are.equal(0,m)
+    end)
+
 end)

tests/floor_spec.lua

@@ -38,6 +38,8 @@ _G.vector = require("vector")
 ---@type Builder_Lib
 local builder
 
+_G.textutils = require("textutils")
+
 
 ---@type TurtleEmulator
 local turtleEmulator = require("turtleEmulator")
@@ -164,6 +166,7 @@ describe("Testing placing Floor", function ()
         if err then error(err) end
         assert.are.equal(100, countTableLength(turtleEmulator.blocks))
         local blocksTested = 0
+        -- print("Blocks placed", textutils.serialize(turtleEmulator.blocks))
         for j = -9, 0, 1 do
             for i = 0, 9, 1 do
                 blocksTested = blocksTested + 1