fix(self): 🧐 Added self-reference to functioncalls when it is missing

The self reference does not exist in CraftOS-turtle-calls, therefore functioncalls without a self reference need to work here as well

Author: ChristophLHR

README.md

@@ -4,7 +4,6 @@ This Emulator is exclusively ment to enable testing CC code with a testingframew
 
 ### WIP
 
-> This Libary is not finished at all at this point and <b><u> will not work yet.</b></u>
 > Should increase in scope incrementally. For now it (will) only keep track of position and turtle-direction
 
 ### HOW TO USE
@@ -15,7 +14,16 @@ local turtleEmulator = require("<path>/turtleEmulator")
 local turtleOne = turtleEmulator:createTurtle()
 local turtleTwo = turtleEmulator:createTurtle()
 
---currently this will only work with a self reference, will work on removing this neccessity
--- one possibilty is a Proxy table in the turtleEmulator #todo
+-- override the default behavior, skipping fuelcheck etc.
+turtleTwo.canMoveToCheck = function() return true end
 
+turtleOne.forward()
+assert(turtleOne.position.x == 1)
+
+--...
 ```
+
+### Restrictions
+
+To allow the creation of multiple turtles within the same Emulator, the turtle returned by createTurtle is only a proxy, meaning that the metatable should not be modified.
+However, should the need ever arise, you can modify it by getmetatable(turtle).\_\_metatable = nil. But please be aware that overriding the \_\_index and \_\_newIndex will break the functionality of the turtle.

tests/test_spec.lua

@@ -43,22 +43,22 @@ describe("Disabled Movement", function()
         end
     end)
     it("Can't move to forward", function()
-        local c, e = turtle:forward()
+        local c, e = turtle.forward()
         assert.is.falsy(c)
         assert.are.equal("Can't move to forward", e)
     end)
     it("Can't move to back", function()
-        local c, e = turtle:back()
+        local c, e = turtle.back()
         assert.is.falsy(c)
         assert.are.equal("Can't move to back", e)
     end)
     it("Can't move to up", function()
-        local c, e = turtle:up()
+        local c, e = turtle.up()
         assert.is.falsy(c)
         assert.are.equal("Can't move to up", e)
     end)
     it("Can't move to down", function()
-        local c, e = turtle:down()
+        local c, e = turtle.down()
         assert.is.falsy(c)
         assert.are.equal("Can't move to down", e)
     end)
@@ -72,22 +72,22 @@ describe("Enabled Movement", function()
         end
     end)
     it("Can move to forward", function()
-        local c, e = turtle:forward()
+        local c, e = turtle.forward()
         assert.is.truthy(c)
         assert.are.equal(nil, e)
     end)
     it("Can move to back", function()
-        local c, e = turtle:back()
+        local c, e = turtle.back()
         assert.is.truthy(c)
         assert.are.equal(nil, e)
     end)
     it("Can move to up", function()
-        local c, e = turtle:up()
+        local c, e = turtle.up()
         assert.is.truthy(c)
         assert.are.equal(nil, e)
     end)
     it("Can move to down", function()
-        local c, e = turtle:down()
+        local c, e = turtle.down()
         assert.is.truthy(c)
         assert.are.equal(nil, e)
     end)
@@ -107,31 +107,31 @@ describe("Track Movement", function()
         turtle.facing = 0
     end)
     it("Move forward", function()
-        local c, e = turtle:forward()
+        local c, e = turtle.forward()
         assert.is.truthy(c)
         assert.are.equal(nil, e)
         assert.are.equal(1, turtle.position.x)
         assert.are.equal(0, turtle.position.z)
         assert.are.equal(0, turtle.position.y)
     end)
     it("Move back", function()
-        local c, e = turtle:back()
+        local c, e = turtle.back()
         assert.is.truthy(c)
         assert.are.equal(nil, e)
         assert.are.equal(-1, turtle.position.x)
         assert.are.equal(0, turtle.position.z)
         assert.are.equal(0, turtle.position.y)
     end)
     it("Move up", function()
-        local c, e = turtle:up()
+        local c, e = turtle.up()
         assert.is.truthy(c)
         assert.are.equal(nil, e)
         assert.are.equal(0, turtle.position.x)
         assert.are.equal(0, turtle.position.z)
         assert.are.equal(1, turtle.position.y)
     end)
     it("Move down", function()
-        local c, e = turtle:down()
+        local c, e = turtle.down()
         assert.is.truthy(c)
         assert.are.equal(nil, e)
         assert.are.equal(0, turtle.position.x)
@@ -154,23 +154,23 @@ describe("Track Facing Direction", function()
         turtle.facing = 0
     end)
     it("Turn right", function()
-        turtle:turnRight()
+        turtle.turnRight()
         assert.are.equal(1, turtle.facing)
     end)
     it("Turn left", function()
-        turtle:turnLeft()
+        turtle.turnLeft()
         assert.are.equal(3, turtle.facing)
     end)
     it("Turn right twice", function()
-        turtle:turnRight()
-        turtle:turnRight()
+        turtle.turnRight()
+        turtle.turnRight()
         assert.are.equal(2, turtle.facing)
     end)
     it("Turn right four times", function()
-        turtle:turnRight()
-        turtle:turnRight()
-        turtle:turnRight()
-        turtle:turnRight()
+        turtle.turnRight()
+        turtle.turnRight()
+        turtle.turnRight()
+        turtle.turnRight()
         assert.are.equal(0, turtle.facing)
     end)
 end)
@@ -189,9 +189,9 @@ describe("Complexer Movement", function()
         turtle.facing = 0
     end)
     it("Move forward, turn right and turn forward", function()
-        assert.is_true(turtle:forward())
-        assert.is_true(turtle:turnRight())
-        local c, e = turtle:forward()
+        assert.is_true(turtle.forward())
+        assert.is_true(turtle.turnRight())
+        local c, e = turtle.forward()
         assert.is.truthy(c)
         assert.are.equal(nil, e)
         assert.are.equal(1, turtle.facing)
@@ -200,12 +200,12 @@ describe("Complexer Movement", function()
         assert.are.equal(0, turtle.position.y)
     end)
     it("Move back, up, right, up, forward and then left", function()
-        assert.is_true(turtle:back())
-        assert.is_true(turtle:up())
-        assert.is_true(turtle:turnRight())
-        assert.is_true(turtle:up())
-        assert.is_true(turtle:forward())
-        assert.is_true(turtle:turnLeft())
+        assert.is_true(turtle.back())
+        assert.is_true(turtle.up())
+        assert.is_true(turtle.turnRight())
+        assert.is_true(turtle.up())
+        assert.is_true(turtle.forward())
+        assert.is_true(turtle.turnLeft())
         assert.are.equal(0, turtle.facing)
         assert.are.equal(-1, turtle.position.x)
         assert.are.equal(1, turtle.position.z)
@@ -252,3 +252,43 @@ describe("multiple Turtles", function()
         assert.are.equal(1, turtle2.facing)
     end)
 end)
+
+describe("ProxyTests", function()
+    local turtle
+    setup(function()
+        turtle = turtleEmulator:createTurtle()
+        turtle["canMoveToCheck"] = function()
+            return true
+        end
+    end)
+
+    it("Create own key Value", function()
+        local functionGotCalled = false
+        turtle.canPrint = true
+        function turtle:thisIsATest(RandomString)
+            assert.are_not.equal(self, turtle, "The self reference is the Proxy instead of the turtle object")
+            assert.are.equal("RandomString", RandomString, "Parameter 2 not correct, might be a self reference?")
+            functionGotCalled = true
+        end
+
+        turtle:thisIsATest("RandomString")
+        assert.are.equal(true, functionGotCalled, "Function was not called")
+        turtle.canPrint = false
+    end)
+
+    it("Change Metatable", function()
+        local mt = getmetatable(turtle)
+        local newMt = {}
+        local gotCalled = 0
+        assert.has_error(function()
+            gotCalled = gotCalled + 1
+            setmetatable(turtle, newMt)
+        end)
+        mt.__metatable = nil
+        assert.has_no.errors(function()
+            gotCalled = gotCalled + 1
+            setmetatable(turtle, newMt)
+        end)
+        assert.are.equal(2, gotCalled, "asserts did not run as expected")
+    end)
+end)

turtleEmulator.lua

@@ -16,16 +16,40 @@ local turtleEmulator = {
     ---@type facing
     facing = nil,
     canMoveToCheck = nil,
+    canPrint = nil,
     createTurtle = function(self)
         local turtle = {
             position = { x = 0, y = 0, z = 0 },
             facing = 0,
             canMoveToCheck = nil
         }
         setmetatable(turtle, { __index = self })
-        return turtle
+
+        local proxy = {}
+        local mt = {}
+        mt.__index = function(_, key)
+            local value = turtle[key]
+            if type(value) == "function" then
+                return function(...)
+                    local mightBeSelf = select(1, ...)
+                    if mightBeSelf == turtle then
+                        return value(...)
+                    elseif mightBeSelf == proxy then
+                        return value(turtle, select(2, ...))
+                    end
+                    return value(turtle, ...)
+                end
+            end
+            return value
+        end
+        mt.__newindex = function(_, key, value)
+            turtle[key] = value
+        end
+        mt.__metatable = mt
+
+        setmetatable(proxy, mt)
+        return proxy
     end,
-    canPrint = nil
 }
 
 
@@ -82,6 +106,7 @@ local function down(self)
 end
 
 function turtleEmulator:forward()
+    self:print(self.canPrint, "Can print")
     local c, e = canMoveTo(self, "forward")
     if not c then
         return c, e
@@ -133,8 +158,8 @@ local mt = {
     end
 }
 
-function turtleEmulator:print(generic)
-    return self.canPrint ~= nil and print(generic)
+function turtleEmulator:print(...)
+    return self.canPrint ~= nil and print(...)
 end
 
 setmetatable(turtleEmulator, mt)