β0.1.2 Improve test suites and add tests

Fix bugs in Path and achieve parity with craywall.nvim
Improve Section:__tostring()
Implement utils.run_command()
Improve formatting in some error messages
Add Github workflow

Author: gitpushjoe

.github/workflows/tests.yml

@@ -0,0 +1,21 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Install Lua
+        run: sudo apt-get update && sudo apt-get install -y lua5.4
+
+      - name: Run tests
+        run: lua ./tests/tests.lua

core/config.lua

@@ -79,7 +79,7 @@ Config.errors = {
 	missing_item_in_note_schema_list = function(list, idx)
 		return "Missing "
 			.. (#list <= 1 and "open-tag" or "close-tag")
-			.. "in config.note_schema["
+			.. " in config.note_schema["
 			.. idx
 			.. "]."
 	end,

core/mock_filesystem/mock_filesystem.lua

@@ -53,4 +53,10 @@ function MockFilesystem:__tostring()
 	return out
 end
 
+---@param rhs MockFilesystem
+---@return boolean
+function MockFilesystem:__eq(rhs)
+	return tostring(self) == tostring(rhs)
+end
+
 return MockFilesystem

core/path.lua

@@ -70,6 +70,9 @@ function Path:new(path, allow_relative)
 		for part in string.gmatch(path, "[^/]+") do
 			table.insert(self.parts, part)
 		end
+		if path:sub(#path, #path) == "/" then
+			table.insert(self.parts, "")
+		end
 		if #self.parts == 1 and self.parts[1] == nil then
 			self.parts = {}
 		end

core/section.lua

@@ -52,7 +52,7 @@ Section.ROOT = "ROOT"
 ---@param context Context
 ---@param start_line number
 ---@param end_line number?
----@param children Section[]
+---@param children Section[]?
 ---@param parent Section?
 ---@param indent string?
 ---@return Section? section
@@ -89,7 +89,7 @@ function Section:new(
 	self.context = utils.read_only(context)
 	self.start_line = start_line
 	self.end_line = end_line
-	self.children = children
+	self.children = children or {}
 	self.parent = parent
 	self.indent = indent or ""
 	return self
@@ -208,7 +208,9 @@ end
 
 ---@return string
 function Section:__tostring()
-	return "Section {"
+	return "Section {\n"
+		.. 'id = '
+		.. self.id
 		.. '\n\ttype = {"'
 		.. self.type[1]
 		.. '", "'

core/utils.lua

@@ -13,7 +13,7 @@ M.str = {
 	---@param suffix string
 	---@return boolean
 	ends_with = function(str, suffix)
-		return string.sub(str, -string.len(suffix)) == suffix
+		return suffix == "" or string.sub(str, -#suffix) == suffix
 	end,
 
 	---@param str string
@@ -97,6 +97,12 @@ M.read_from_handle = function(handle)
 	return res
 end
 
+---@param cmd string
+---@return string?
+M.run_command = function(cmd)
+	return M.read_from_handle(io.popen(cmd))
+end
+
 ---@return string
 M.get_home_directory = function()
 	return assert(M.read_from_handle(io.popen("echo $HOME")) .. "/")

core/version.lua

@@ -1 +1 @@
-return "β0.1.1"
+return "β0.1.2"