β0.2.0

perf!: Support luajit instead of lua
perf: Refactor `utils.str.split_lines_to_list` to have identical behavior in lua and luajit
      In testing, this new algorithm is 10.5x slower in lua `( 5.511s -> 63.593s)`
      but 42% faster in luajit `( 7.439s ->  4.283s)`
feat: Implement `fold.fold`, a streamlined API for running crazywall
fix(ermsgs): Plan stream logged instead of text stream
fix: Replace `math.tointeger` with `tonumber`
refactor!: Move `core/` to `crazywall/core/`
style: Indent `id` when logging `Section`
test: Remove uninvoked error
test: Reach 100% error coverage

Author: gitpushjoe

.github/workflows/tests.yml

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install Lua
-        run: sudo apt-get update && sudo apt-get install -y lua5.4
+        run: sudo apt-get update && sudo apt-get install -y luajit
 
       - name: Run tests
-        run: lua ./tests/tests.lua
+        run: luajit ./tests/tests.lua

configs.lua

@@ -1,5 +1,5 @@
-local utils = require("core.utils")
-local Path = require("core.path")
+local utils = require("crazywall.core.utils")
+local Path = require("crazywall.core.path")
 
 ---@type table<string, PartialConfigTable>
 local configs = {

core/version.lua

@@ -1,5 +1,5 @@
-local validate = require("core.validate")
-local default_config = require("core.defaults.config")
+local validate = require("crazywall.core.validate")
+local default_config = require("crazywall.core.defaults.config")
 
 --- @alias NoteSchema [string, string, string][]
 

core/ansi.lua crazywall/core/ansi.luacore/ansi.lua renamed to crazywall/core/ansi.lua

@@ -1,9 +1,9 @@
-local utils = require("core.utils")
-local Path = require("core.path")
-local validate = require("core.validate")
+local utils = require("crazywall.core.utils")
+local Path = require("crazywall.core.path")
+local validate = require("crazywall.core.validate")
 local str = utils.str
-local streams = require("core.streams")
-local Config = require("core.config")
+local streams = require("crazywall.core.streams")
+local Config = require("crazywall.core.config")
 
 --- Represents the current state during execution, configuration options, and
 --- command-line arguments.
@@ -149,7 +149,7 @@ function Context:new(
 		and text_stream ~= streams.STDOUT
 		and text_stream ~= streams.STDERR
 	then
-		return nil, Context.errors.invalid_value_for_text_stream(plan_stream)
+		return nil, Context.errors.invalid_value_for_text_stream(text_stream)
 	end
 
 	self.lines = {}
@@ -161,10 +161,7 @@ function Context:new(
 	local lines = {}
 	if type(inp) == type("") then
 		---@cast inp string
-		local data = str.split_lines(inp, true)
-		for line in data do
-			table.insert(lines, line)
-		end
+		lines = str.split_lines_to_list(inp, true)
 	else
 		---@cast inp string[]
 		for i, line in ipairs(inp) do

core/config.lua crazywall/core/config.luacore/config.lua renamed to crazywall/core/config.lua

@@ -1,5 +1,5 @@
-local utils = require("core.utils")
-local Path = require("core.path")
+local utils = require("crazywall.core.utils")
+local Path = require("crazywall.core.path")
 
 ---@type Config
 local default_config = {

core/context.lua crazywall/core/context.luacore/context.lua renamed to crazywall/core/context.lua

@@ -1,11 +1,11 @@
-local utils = require("core.utils")
+local utils = require("crazywall.core.utils")
 local str = utils.str
-local Section = require("core.section")
-local traverse = require("core.traverse")
-local validate = require("core.validate")
-local Plan = require("core.plan.plan")
-local Action = require("core.plan.action")
-local Path = require("core.path")
+local Section = require("crazywall.core.section")
+local traverse = require("crazywall.core.traverse")
+local validate = require("crazywall.core.validate")
+local Plan = require("crazywall.core.plan.plan")
+local Action = require("crazywall.core.plan.action")
+local Path = require("crazywall.core.path")
 
 --- Functions for the primary crazywall operation.
 local M = {}
@@ -62,12 +62,6 @@ M.errors = {
 			.. "\nError: "
 			.. (err or "")
 	end,
-
-	---@param path string
-	---@return string errmsg
-	expected_file_to_be_writable = function(path)
-		return "Expected file " .. tostring(path) .. " to be writable"
-	end,
 }
 
 ---@param ctx Context
@@ -161,7 +155,7 @@ end
 
 ---@param section_root Section
 ---@param ctx Context
----@return nil
+---@return boolean?
 ---@return string? errmsg
 M.prepare = function(section_root, ctx)
 	---@type { [string]: Section }
@@ -262,6 +256,8 @@ M.prepare = function(section_root, ctx)
 	if err then
 		return nil, err
 	end
+
+	return true
 end
 
 ---@param section_root Section
@@ -432,4 +428,53 @@ M.execute = function(section_root, ctx, is_dry_run)
 	return plan
 end
 
+---@param ctx Context
+---@param display_plan_func (fun(ctx: Context, plan: Plan, is_dry_run: boolean): nil)?
+---@param display_lines_func (fun(ctx: Context, lines: string[], is_dry_run: boolean): nil)?
+---@param get_confirmation (fun(): boolean)?
+---@return Plan? plan
+---@return string? errmsg
+---@return Section? root
+function M.fold(ctx, display_plan_func, display_lines_func, get_confirmation)
+	display_plan_func = display_plan_func or function() end
+	display_lines_func = display_lines_func or function() end
+	get_confirmation = get_confirmation or function()
+		return true
+	end
+	local root, err = M.parse(ctx)
+	if not root then
+		return nil, err
+	end
+
+	_, err = M.prepare(root, ctx)
+	if err then
+		return nil, err, root
+	end
+
+	local plan
+	plan, err = M.execute(root, ctx, true)
+	if not plan then
+		return nil, err, root
+	end
+
+	display_plan_func(ctx, plan, ctx.is_dry_run)
+	if ctx.is_dry_run then
+		display_lines_func(ctx, root:get_lines(), true)
+		return plan, nil, root
+	end
+
+	if not ctx.auto_confirm and not get_confirmation() then
+		return plan, nil, root
+	end
+
+	plan, err = M.execute(root, ctx, false)
+	if not plan then
+		return nil, err, root
+	end
+
+	display_lines_func(ctx, root:get_lines(), false)
+	return plan, nil, root
+end
+
+
 return M

core/defaults/config.lua crazywall/core/defaults/config.luacore/defaults/config.lua renamed to crazywall/core/defaults/config.lua

@@ -1,8 +1,8 @@
-local mock_fs_utils = require("core.mock_filesystem.utils")
-local Handle = require("core.mock_filesystem.handle")
-local ProcessHandle = require("core.mock_filesystem.process_handle")
-local validate = require("core.validate")
-local Path = require("core.path")
+local mock_fs_utils = require("crazywall.core.mock_filesystem.utils")
+local Handle = require("crazywall.core.mock_filesystem.handle")
+local ProcessHandle = require("crazywall.core.mock_filesystem.process_handle")
+local validate = require("crazywall.core.validate")
+local Path = require("crazywall.core.path")
 
 ---@class MockFS_IO
 ---@field mock_filesystem MockFilesystem
@@ -53,6 +53,11 @@ MockFS_IO.errors = {
 	cannot_create_directory_file_exists = function(path)
 		return "mkdir: cannot create directory `" .. path .. "`: File exists"
 	end,
+
+	--- @return string
+	manually_forced_error = function()
+		return "This error was manually forced to be raised."
+	end,
 }
 
 local function make_function_open(self)
@@ -103,6 +108,9 @@ local function make_function_popen(self)
 	--- @param command string
 	--- @return MockFS_ProcHandle?, string?
 	return function(command)
+		if self.mock_filesystem._debug_error_on_all_commands then
+			return nil, MockFS_IO.errors.manually_forced_error()
+		end
 		local match = string.gmatch(command, "mkdir %-p '(.*)' 2>%&1")()
 		if not match then
 			return nil,