release 2.0: the library straight up didn't work. now it does

Author: thacuber2a03

init.lua

@@ -9,7 +9,7 @@ local min, max = math.min, math.max
 ---@field public maxY number
 ---@overload fun(minX: number, minY: number, maxX: number, maxY: number): Rect
 ---@overload fun(r: {minX: number, minY: number, maxX: number, maxY: number}): Rect
-local Rect = { _version = "1.0" }
+local Rect = { _version = "2.0" }
 Rect.__index = Rect
 
 ---Creates a new Rect. Equivalent to calling the class: `Rect(...)`.
@@ -29,7 +29,7 @@ function Rect.new(minX, minY, maxX, maxY)
         minY = minY,
         maxX = maxX,
         maxY = maxY,
-    }, Rect)
+    }, Rect --[[@as table]])
 end
 
 ---Creates a new Rect from XYWH parameters.
@@ -49,7 +49,7 @@ function Rect.fromXYWH(x, y, width, height)
         minY = y,
         maxX = x + width,
         maxY = y + height,
-    }, Rect)
+    }, Rect --[[@as table]])
 end
 
 ---Returns all components of this Rect.
@@ -157,7 +157,7 @@ end
 ---@return Rect
 function Rect:cut_left(a)
     local left = self:get_left(a)
-    self.minX = left.minX
+    self.minX = left.maxX
     return left
 end
 
@@ -172,7 +172,7 @@ function Rect:cutLeft(a) return Rect:cut_left(a) end
 ---@return Rect
 function Rect:cut_right(a)
     local right = self:get_right(a)
-    self.maxX = right.maxX
+    self.maxX = right.minX
     return right
 end
 
@@ -187,7 +187,7 @@ function Rect:cutRight(a) return Rect:cut_right(a) end
 ---@return Rect
 function Rect:cut_top(a)
     local top = self:get_top(a)
-    self.minY = top.minY
+    self.minY = top.maxY
     return top
 end
 
@@ -202,7 +202,7 @@ function Rect:cutTop(a) return Rect:cut_top(a) end
 ---@return Rect
 function Rect:cut_bottom(a)
     local bottom = self:get_bottom(a)
-    self.maxY = bottom.maxY
+    self.maxY = bottom.minY
     return bottom
 end
 
@@ -212,7 +212,7 @@ end
 ---@see Rect.cut_bottom
 function Rect:cutBottom(a) return Rect:cut_bottom(a) end
 
----Returns this rect, with `a` added to its left side.
+---Returns a copy of this rect, with `a` added to its left side.
 ---@param a number
 ---@return Rect
 function Rect:add_left(a) return Rect.new(self.minX - a, self.minY, self.maxX, self.maxY) end
@@ -223,7 +223,7 @@ function Rect:add_left(a) return Rect.new(self.minX - a, self.minY, self.maxX, s
 ---@see Rect.add_left
 function Rect:addLeft(a) return Rect:add_left(a) end
 
----Returns this rect, with `a` added to its right side.
+---Returns a copy of this rect, with `a` added to its right side.
 ---@param a number
 ---@return Rect
 function Rect:add_right(a) return Rect.new(self.minX, self.minY, self.maxX + a, self.maxY) end
@@ -234,7 +234,7 @@ function Rect:add_right(a) return Rect.new(self.minX, self.minY, self.maxX + a,
 ---@see Rect.add_right
 function Rect:addRight(a) return Rect:add_right(a) end
 
----Returns this rect, with `a` added to its top side.
+---Returns a copy of this rect, with `a` added to its top side.
 ---@param a number
 ---@return Rect
 function Rect:add_top(a) return Rect.new(self.minX, self.minY - a, self.maxX, self.maxY) end
@@ -245,7 +245,7 @@ function Rect:add_top(a) return Rect.new(self.minX, self.minY - a, self.maxX, se
 ---@see Rect.add_top
 function Rect:addTop(a) return Rect:add_top(a) end
 
----Returns this rect, with `a` added to its bottom side.
+---Returns a copy of this rect, with `a` added to its bottom side.
 ---@param a number
 ---@return Rect
 function Rect:add_bottom(a) return Rect.new(self.minX, self.minY, self.maxX, self.maxY + a) end
@@ -278,9 +278,9 @@ function Rect:contract(a) return Rect.new(self.minX + a, self.minY + a, self.max
 
 ---@return string
 function Rect:__tostring()
-    return string.format("Rect: X(%f-%f), Y(%f-%f)", self:unpack())
+    return string.format("Rect: min(%g,%g), max(%g,%g)", self:unpack())
 end
 
-return setmetatable(Rect, {
+return setmetatable(Rect --[[@as table]], {
     __call = function(cls, ...) return cls.new(...) end,
-})
+}) --[[@as Rect]]

tests.lua

@@ -2,9 +2,9 @@ local Rect = require 'init'
 
 local fail = false
 
-local function testEqualRects(name, a, b)
+local function test(name, a, b)
     if a.minX ~= b.minX or a.minY ~= b.minY
-        or a.maxX ~= b.maxX or a.maxY ~= b.maxY then
+    or a.maxX ~= b.maxX or a.maxY ~= b.maxY then
         io.write(name .. " failed: expected " .. tostring(b) .. ", got " .. tostring(a) .. "\n")
         fail = true
         return false
@@ -14,6 +14,43 @@ local function testEqualRects(name, a, b)
     end
 end
 
--- TODO: actually write tests lmfao
+--- tests taken from the Rust implementation, thanks and sorry
 
-if fail then io.write("\nsome tests have failed, please check results\n") end
+local base = Rect(0, 0, 10, 10)
+local rect = base:copy()
+test("copy call", rect, base)
+
+test("get_left call", rect:get_left(1), Rect(0, rect.minY, 1, rect.maxY))
+test("get_right call", rect:get_right(1), Rect(9, rect.minY, 10, rect.maxY))
+test("get_bottom call", rect:get_bottom(1), Rect(rect.minX, 9, rect.maxX, 10))
+test("get_top call", rect:get_top(1), Rect(rect.minX, 0, rect.maxX, 1))
+
+test("cut_left call", rect:cut_left(1), Rect(0, rect.minY, 1, rect.maxY))
+test("cut_left result", rect, Rect(1, 0, 10, 10))
+test("add_left call", rect:add_left(1), base)
+
+rect = base:copy()
+test("cut_right call", rect:cut_right(1), Rect(9, rect.minY, 10, rect.maxY))
+test("cut_right result", rect, Rect(0, 0, 9, 10))
+test("add_right result", rect:add_right(1), base)
+
+rect = base:copy()
+test("cut_right call", rect:cut_right(1), Rect(9, rect.minY, 10, rect.maxY))
+test("cut_right result", rect, Rect(0, 0, 9, 10))
+test("add_right result", rect:add_right(1), base)
+
+rect = base:copy()
+test("cut_bottom call", rect:cut_bottom(1), Rect(rect.minX, 9, rect.maxX, 10))
+test("cut_bottom result", rect, Rect(0, 0, 10, 9))
+test("add_bottom result", rect:add_bottom(1), base)
+
+rect = base:copy()
+test("cut_top call", rect:cut_top(1), Rect(rect.minX, 0, rect.maxX, 1))
+test("cut_top result", rect, Rect(0, 1, 10, 10))
+test("add_top result", rect:add_top(1), base)
+
+test("contract call", base:contract(1), Rect(1, 1, 9, 9))
+test("extend call", base:extend(1), Rect(-1, -1, 11, 11))
+
+io.write "\n"
+if fail then io.write "some tests have failed, please check results\n" else io.write "all tests pass :D\n" end