refactor: 🗑️ Cleaned up some legacy Suitsrelated stuff

Author: ChristophLHR

inventory.lua

@@ -1,3 +1,4 @@
+--#region Definitions
 ---@class placeAction
 ---@field funciton fun(turtle: TurtleProxy | TurtleMock, item: item, position: position): boolean , any[]
 
@@ -31,7 +32,10 @@
 ---@field list fun(): item[]
 ---@field getType fun(): string
 ---@field __index any
----@field deepCopy fun(table: table): table
+--#endregion
+
+
+local deepCopy = require("./TestSuite-lib/helperFunctions/helperFunctions").deepCopy
 
 ---# inventory
 ---Inventory system emulated
@@ -108,7 +112,7 @@ local function pickUpItem(inventory, item, slot)
             local toTransfer = math.min(space, item.count)
 
             local currentCount = getItemCount(inventory, fittingSlot)
-            inventory[fittingSlot] = inventory.deepCopy(item)
+            inventory[fittingSlot] = deepCopy(item)
             if (inventory[fittingSlot] == nil) then
                 inventory[fittingSlot].maxcount = item.maxcount or inventory.defaultMaxSlotSize
             end
@@ -141,12 +145,11 @@ end
 ---@param inventorySize number | nil
 ---@param deepCopy fun(table: table): table
 ---@return inventory
-function inventory:createInventory(inventorySize, deepCopy) 
+function inventory:createInventory(inventorySize) 
     local i = {
         inventorySize = inventorySize or 27,
         selectedSlot = 1,
-        defaultMaxSlotSize = 64,
-        deepCopy = deepCopy
+        defaultMaxSlotSize = 64
     }
     setmetatable(i, self)
     self.__index = self
@@ -227,7 +230,7 @@ function inventory:transferTo(slot, count)
         if currentSlot == nil then
             return true
         end
-        self[slot] = self.deepCopy(self[self.selectedSlot])
+        self[slot] = deepCopy(self[self.selectedSlot])
         self[slot].count =  math.min(self[slot] and self[slot].maxcount or 0 , count)
         local transferTo = math.min(currentSlot.count, count)
         currentSlot.count = currentSlot.count - transferTo

peripheral.lua

@@ -16,6 +16,7 @@ to simulate the normal behavior of a turtle interacting with a peripheral.
 ]]
 
 
+--#region Definitions
 ---@alias filterFunc fun(name: string, wrapped: table):boolean
 
 ---@alias relativePosition
@@ -26,14 +27,7 @@ to simulate the normal behavior of a turtle interacting with a peripheral.
 --- | "left"
 --- | "right"
 
-local relativePositionOptions = {
-    ["right"] = true,
-    ["left"] = true,
-    ["front"] = true,
-    ["back"] = true,
-    ["top"] = true,
-    ["bottom"] = true
-}
+
 
 ---@class PeripheralModule
 ---@field turtle TurtleMock
@@ -44,12 +38,23 @@ local relativePositionOptions = {
 ---@field isPresent fun(peripheral: PeripheralModule, positionOrname: any):boolean
 ---@field getType fun(peripheral: PeripheralModule, Peripheral: peripheralActions):string|nil
 ---@field __index PeripheralModule
+--#endregion
 
+---@type Vector
+local vector = require("./TestSuite-lib/vector/vector")
+
+local relativePositionOptions = {
+    ["right"] = true,
+    ["left"] = true,
+    ["front"] = true,
+    ["back"] = true,
+    ["top"] = true,
+    ["bottom"] = true
+}
 --- Maps the relative positions of the turtle to the absolute positions of the emulator
 ---@param turtle TurtleMock
 ---@return table<relativePosition, Vector>
 local function positionMapper(turtle)
-    local vector = turtle.emulator.suit.vector
     return {
         ["front"] = turtle.position + turtle.facing,
         ["back"] = turtle.position - turtle.facing,

tests/test_spec.lua

@@ -34,7 +34,6 @@ local vector = require("./TestSuite-lib/vector/vector")
 local deepCopy = require("./TestSuite-lib/helperFunctions/helperFunctions").deepCopy
 
 local turtleEmulator = require("../turtleEmulator")
-turtleEmulator:init(vector, deepCopy)
 local peripheral = require("../peripheral")
 describe("Disabled Movement", function()
     local turtle

turtleEmulator.lua

@@ -18,10 +18,6 @@
 ---@field peripheralActions peripheralActions | nil
 ---@field peripheralName string | nil
 
----@class Suits
----@field vector Vector
----@field deepCopy fun(table: table): table
----
 --- used from the Scanner, as the blocks will most likely be scanned, saved and then inserted into the turtleEmulator for testing
 ---@class ScanData
 ---@field x number
@@ -40,6 +36,8 @@ local turtleM = require("./turtleMock")
 local defaultInteration = require("../defaultInteraction")
 local defaultcheckActionValid = require("./defaultcheckActionValid")
 local inventory = require("./inventory")
+---@type Vector
+local vector = require("./TestSuite-lib/vector/vector")
 
 ---comment
 ---@param position Vector
@@ -56,9 +54,9 @@ local turtleEmulator = {
     blocks = {},
     turtleID = 1,
     createTurtle = function(self)
-        assert(self.suit.vector, "No Vector-Lib found")
+        assert(vector, "No Vector-Lib found")
         ---@type TurtleProxy
-        local t = turtleM.createMock(self, self.turtleID, self.suit, self.suit.vector.new(0,0,0), self.suit.vector.new(1, 0, 0))
+        local t = turtleM.createMock(self, self.turtleID, self.suit, vector.new(0,0,0), vector.new(1, 0, 0))
         self.turtles[self.turtleID] = t
         self.turtleID = self.turtleID + 1
         return t
@@ -74,16 +72,6 @@ local function createPositionKey(position)
     return position.x .. "," .. position.y .. "," .. position.z
 end
 
---- required for vector-library
----@param vector Vector
----@param copyTableFunction fun(table: table): table
-function turtleEmulator:init(vector, copyTableFunction)
-    assert("table" == type(vector), "vector is not a table, but of type: " .. type(vector))
-    assert("function" == type(copyTableFunction), "copyTableFunction is not a function, but of type: " .. type(copyTableFunction))
-    turtleEmulator.suit.vector = vector
-    turtleEmulator.suit.deepCopy = copyTableFunction
-end
-
 --- Adds a block to the emulated world
 ---@param block block
 function turtleEmulator:createBlock(block)
@@ -152,7 +140,7 @@ function turtleEmulator:addInventoryToBlock(position)
     if block == nil then
         return
     end
-    block.peripheralActions = inventory:createInventory(nil, self.suit.deepCopy)
+    block.peripheralActions = inventory:createInventory(nil)
     block.peripheralName = "inventory"
     return self:playPeripheralProxy(position)
 end

turtleMock.lua

@@ -74,6 +74,10 @@
 local peripheral = require("../peripheral")
 local defaultInteraction = require("../defaultInteraction")
 local inventory = require("../inventory")
+---@type Vector
+local vector = require("./TestSuite-lib/vector/vector")
+local deepCopy = require("./TestSuite-lib/helperFunctions/helperFunctions").deepCopy
+
 
 --- this class should not be used directly, use the createMock of the turtleEmulator function instead, which will set the proxy
 ---@type TurtleMock
@@ -141,7 +145,7 @@ local function up(self, act)
     if act == nil then
         act = true
     end
-    local newPosition = self.position + self.suits.vector.new(0, 1, 0)
+    local newPosition = self.position + vector.new(0, 1, 0)
     if self.emulator:getBlock(newPosition) ~= nil then
         return false, "Movement obstructed by " .. self.emulator:getBlock(newPosition).item.name, newPosition
     end
@@ -165,7 +169,7 @@ local function down(self, act)
     if act == nil then
         act = true
     end
-    local newPosition = self.position + self.suits.vector.new(0, -1, 0)
+    local newPosition = self.position + vector.new(0, -1, 0)
     if self.emulator:getBlock(newPosition) ~= nil then
         return false, "Movement obstructed by " .. self.emulator:getBlock(newPosition).item.name, newPosition
     end
@@ -199,7 +203,7 @@ local function equip(turtle, slot, side)
         return false, "Not a valid upgrade"
     end
     local equipedItem
-    local itemCopy = turtle.suits.deepCopy(item)
+    local itemCopy = deepCopy(item)
     if turtle.equipslots == nil  then
             turtle.equipslots = {side = itemCopy}
     else
@@ -370,7 +374,7 @@ local function drop(turtle, position, count)
     if _item == nil then
         return false, "No item to drop"
     end
-    local item = turtle.emulator.suit.deepCopy(_item)
+    local item = deepCopy(_item)
     count = count or 1
     item.count = count
 
@@ -390,15 +394,15 @@ end
 function turtleMock.createMock(emulator, id, suits, position, facingPos)
     local turtle = {
         ---@type position
-        position = position or suits.vector.new(0, 0, 0),
+        position = position or vector.new(0, 0, 0),
         ---@type Vector
-        facing = facingPos or suits.vector.new(1, 0, 0),
+        facing = facingPos or vector.new(1, 0, 0),
         ---@type number
         fuelLevel = 0,
         ---@type boolean
         canPrint = false,
         ---@type inventory
-        inventory = inventory:createInventory(16, suits.deepCopy),
+        inventory = inventory:createInventory(16),
         ---@type integer
         selectedSlot = 1,
         ---@type integer
@@ -609,14 +613,14 @@ function turtleMock:dig()
 end
 
 function turtleMock:digUp()
-    local blockPos = (self.position + self.suits.vector.new(0, 1, 0))
+    local blockPos = (self.position + vector.new(0, 1, 0))
     local block = self.emulator:getBlock(blockPos)
     assert(block, "Block not found at position: " .. tostring(blockPos))
     return dig(self, block)
 end
 
 function turtleMock:digDown()
-    local blockPos = (self.position + self.suits.vector.new(0, -1, 0))
+    local blockPos = (self.position + vector.new(0, -1, 0))
     local block = self.emulator:getBlock(blockPos)
     assert(block, "Block not found at position: " .. tostring(blockPos))
     return dig(self, block)
@@ -688,13 +692,13 @@ end
 ---@param count integer
 ---@return boolean
 function turtleMock:dropDown(count)
-    return drop(self, self.position + self.suits.vector.new(0, -1, 0), count)
+    return drop(self, self.position + vector.new(0, -1, 0), count)
 end
 
 ---@param count integer
 ---@return boolean
 function turtleMock:dropUp(count)
-    return drop(self, self.position + self.suits.vector.new(0, 1, 0), count)
+    return drop(self, self.position + vector.new(0, 1, 0), count)
 end
 
 ---@param count integer