added settings and textutils

Author: ChristophLHR

.github/workflows/test.yml

@@ -33,4 +33,4 @@ jobs:
 
     - name: test
       run: |
-        busted vector
+        busted tests/

files.txt

@@ -2,4 +2,6 @@ vector.lua
 http.lua
 fs.lua
 json.lua
-scm.lua
+scm.lua
+textutils.lua
+settings.lua

settings.lua

@@ -0,0 +1,148 @@
+---@class SettingsManager
+SettingsManager = {}
+
+-- TODO:
+-- Check how / if defines (Details) are saved
+
+local textutils = require("textutils")
+
+---@alias settingType
+---| "string"
+---| "number"
+---| "boolean"
+---| "table"
+
+
+---@class SettingDetail
+---@field default any
+---@field description string
+---@field type settingType
+
+---@type {[string]: SettingDetail}
+local details = {}
+
+---@type {[string]: any}
+    local settings = {}
+
+local defaultPath = "tmp/.settings"
+
+
+local function reserialize(value)
+    if type(value) ~= "table" then return value end
+    return textutils.unserialize(textutils.serialize(value))
+end
+
+
+    ---@param name string
+---@param options SettingDetail 
+function SettingsManager.define(name, options)
+    details[name] = {}
+    if options ~= nil then
+        details[name] = options
+    end
+end
+
+---@param name string
+function SettingsManager.undefine(name)
+    details[name] = nil
+end
+
+---@param name string
+---@param value any
+function SettingsManager.set(name, value)
+    settings[name] = value
+end
+
+---@param name string
+---@param default any
+---@return any
+function SettingsManager.get(name, default)
+    if settings[name] ~= nil then
+        return settings[name]
+    end
+    if default ~= nil then
+        return default
+    end
+    return (details[name] and details[name]["default"]) or nil
+end
+
+---@param name string
+---@return any
+function SettingsManager.getDetails(name)
+    local tmp = details[name]
+    if settings[name] ~= nil then 
+        if tmp == nil then
+            tmp = {}
+        end
+        tmp["value"] = settings[name]
+    end
+    return tmp
+end
+
+---@param name string
+function SettingsManager.unset(name)
+    settings[name] = nil
+end
+
+--- clears Settings (values only)
+function SettingsManager.clear()
+    settings = {}
+end
+
+--- clears Details (Defines only)
+--- does not exist in cc, but might be usefull for testing
+function SettingsManager.clearDetails()
+    details = {}
+end
+
+---@return table<string>
+function SettingsManager.getNames()
+    ---@source https://github.com/cc-tweaked/CC-Tweaked/blob/876fd8ddb805365c33942afb81d6da7cbd0cbca5/projects/core/src/main/resources/data/computercraft/lua/rom/apis/settings.lua#L199
+    local result, n = {}, 1
+    for k in pairs(details) do
+        result[n], n = k, n + 1
+    end
+    for k in pairs(settings) do
+        if not details[k] then result[n], n = k, n + 1 end
+    end
+    table.sort(result)
+    return result
+end
+
+---@param path string | nil
+function SettingsManager.load(path)
+    path = path or defaultPath
+    local file = io.open(path, "r")
+    if file == nil then
+        return false
+    end
+    local content = file:read("*all")
+    file:close()
+    local result = textutils.unserialize(content)
+    if not result or (type(result) ~= "table") then
+        return false
+    end
+    settings = result
+    return true
+end
+
+---@param path string | nil
+function SettingsManager.save(path)
+    if path == nil then 
+        path = defaultPath
+    end
+    if not os.execute("mkdir -p $(dirname ".. path .. ")") then
+        error("Could not create the file")
+    end
+    local result = textutils.serialize(settings)
+    local file = io.open(path, "w")
+    if file == nil then
+        error("Could not save to File: "..path)
+    end
+    file:write(result)
+    file:close()
+    return true
+
+end
+
+return SettingsManager

tests/settings_spec.lua

@@ -0,0 +1,86 @@
+---@class are
+---@field same function
+---@field equal function
+---@field equals function
+
+---@class is
+---@field truthy function
+---@field falsy function
+---@field not_true function
+---@field not_false function
+
+---@class has
+---@field error function
+---@field errors function
+
+---@class assert
+---@field are are
+---@field is is
+---@field are_not are
+---@field is_not is
+---@field has has
+---@field has_no has
+---@field True function
+---@field False function
+---@field has_error function
+---@field is_false function
+---@field is_true function
+---@field equal function
+assert = assert
+
+
+---@class SettingsManager
+local settings = require("settings")
+
+local settingsFile = "tmp/.settings"
+
+describe('Settings', function()
+    ---@class SettingDetail
+    local detail
+    ---@type any
+    local setting
+
+    before_each(function ()
+        settings.clear()
+        settings.clearDetails()
+        detail = {
+            description = "This is a test Setting",
+            default = {["value"] = 14, ["value2"] = "fourteen"},
+            type = "table"
+        }
+        setting = {["value"] = 15, ["value2"] = "fifteen"}
+    end)
+    after_each(function ()
+        os.execute("rm -f "..settingsFile)
+    end)
+    it('define', function()
+        settings.define("Test01", detail)
+        local result = settings.getDetails("Test01")
+        assert.are.equal(detail, result)
+    end)
+    it('getNames', function()
+        settings.define("Test01", detail)
+        local result = settings.getNames()
+        assert.are.same({"Test01"}, result)
+    end)
+    it('get & getDetails', function()
+        settings.define("Test01", detail)
+        local result = settings.get("Test01")
+        assert.are.same(detail.default, result)
+        result = settings.getDetails("Test01")
+    end)
+    it('save and load', function()
+        settings.define("Test01", detail)
+        local result = settings.load(settingsFile)
+        assert.are.same(false, result)
+        settings.set("Test01", setting)
+        settings.save(settingsFile)
+        settings.clear()
+        settings.clearDetails()
+        result = settings.load(settingsFile)
+        assert.is_true(result)
+        local get_result = settings.get("Test01")
+        assert.are.same(setting, get_result)
+    end)
+        
+end)

vector/tests/test_spec.lua renamed to tests/vector_spec.lua

@@ -0,0 +1,135 @@
+---@source https://raw.githubusercontent.com/cc-tweaked/CC-Tweaked/876fd8ddb805365c33942afb81d6da7cbd0cbca5/projects/core/src/main/resources/data/computercraft/lua/rom/apis/textutils.lua
+
+local TextUtils = {}
+
+--#region local functions
+
+local g_tLuaKeywords = {
+    ["and"] = true,
+    ["break"] = true,
+    ["do"] = true,
+    ["else"] = true,
+    ["elseif"] = true,
+    ["end"] = true,
+    ["false"] = true,
+    ["for"] = true,
+    ["function"] = true,
+    ["if"] = true,
+    ["in"] = true,
+    ["local"] = true,
+    ["nil"] = true,
+    ["not"] = true,
+    ["or"] = true,
+    ["repeat"] = true,
+    ["return"] = true,
+    ["then"] = true,
+    ["true"] = true,
+    ["until"] = true,
+    ["while"] = true,
+}
+
+--- A version of the ipairs iterator which ignores metamethods
+local function inext(tbl, i)
+    i = (i or 0) + 1
+    local v = rawget(tbl, i)
+    if v == nil then return nil else return i, v end
+end
+
+local serialize_infinity = math.huge
+local function serialize_impl(t, tracking, indent, opts)
+    local sType = type(t)
+    if sType == "table" then
+        if tracking[t] ~= nil then
+            if tracking[t] == false then
+                error("Cannot serialize table with repeated entries", 0)
+            else
+                error("Cannot serialize table with recursive entries", 0)
+            end
+        end
+        tracking[t] = true
+
+        local result
+        if next(t) == nil then
+            -- Empty tables are simple
+            result = "{}"
+        else
+            -- Other tables take more work
+            local open, sub_indent, open_key, close_key, equal, comma = "{\n", indent .. "  ", "[ ", " ] = ", " = ", ",\n"
+            if opts.compact then
+                open, sub_indent, open_key, close_key, equal, comma = "{", "", "[", "]=", "=", ","
+            end
+
+            result = open
+            local seen_keys = {}
+            for k, v in inext, t do
+                seen_keys[k] = true
+                result = result .. sub_indent .. serialize_impl(v, tracking, sub_indent, opts) .. comma
+            end
+            for k, v in next, t do
+                if not seen_keys[k] then
+                    local sEntry
+                    if type(k) == "string" and not g_tLuaKeywords[k] and string.match(k, "^[%a_][%a%d_]*$") then
+                        sEntry = k .. equal .. serialize_impl(v, tracking, sub_indent, opts) .. comma
+                    else
+                        sEntry = open_key .. serialize_impl(k, tracking, sub_indent, opts) .. close_key .. serialize_impl(v, tracking, sub_indent, opts) .. comma
+                    end
+                    result = result .. sub_indent .. sEntry
+                end
+            end
+            result = result .. indent .. "}"
+        end
+
+        if opts.allow_repetitions then
+            tracking[t] = nil
+        else
+            tracking[t] = false
+        end
+        return result
+
+    elseif sType == "string" then
+        return string.format("%q", t)
+
+    elseif sType == "number" then
+        if t ~= t then --nan
+            return "0/0"
+        elseif t == serialize_infinity then
+            return "1/0"
+        elseif t == -serialize_infinity then
+            return "-1/0"
+        else
+            return tostring(t)
+        end
+
+    elseif sType == "boolean" or sType == "nil" then
+        return tostring(t)
+
+    else
+        error("Cannot serialize type " .. sType, 0)
+
+    end
+end
+
+--#endregion
+
+function TextUtils.serialize(t, opts)
+    local tTracking = {}
+    return serialize_impl(t, tTracking, "", opts or {})
+end
+
+---@param s string
+---@return table | nil
+function TextUtils.unserialize(s)
+    if type(s) ~= "string" then
+        return nil
+    end
+    local func = loadstring("return " .. s, "unserialize", "t", {})
+    if func then
+        local ok, result = pcall(func)
+        if ok then
+            return result
+        end
+    end
+    return nil
+end
+
+return TextUtils