canola.nvim/spec/tmpdir.lua
Barrett Ruth 0d3088f57e
refactor: rename oil to canola across entire codebase (#70)
Problem: the codebase still used the upstream \`oil\` naming everywhere —
URL schemes, the \`:Oil\` command, highlight groups, user events, module
paths, filetypes, buffer/window variables, LuaCATS type annotations,
vimdoc help tags, syntax groups, and internal identifiers.

Solution: mechanical rename of every reference. URL schemes now use
\`canola://\` (plus \`canola-ssh://\`, \`canola-s3://\`, \`canola-sss://\`,
\`canola-trash://\`, \`canola-test://\`). The \`:Canola\` command replaces
\`:Oil\`. All highlight groups, user events, augroups, namespaces,
filetypes, require paths, type annotations, help tags, and identifiers
follow suit. The \`upstream\` remote to \`stevearc/oil.nvim\` has been
removed and the \`vim.g.oil\` deprecation shim dropped.
2026-03-05 14:50:10 -05:00

156 lines
3.8 KiB
Lua

local fs = require('canola.fs')
local test_util = require('spec.test_util')
---@param path string
local function touch(path)
local fd, open_err = vim.loop.fs_open(path, 'w', 420) -- 0644
if not fd then
error(open_err)
end
local shortpath = path:gsub('^[^' .. fs.sep .. ']*' .. fs.sep, '')
local _, write_err = vim.loop.fs_write(fd, shortpath)
if write_err then
error(write_err)
end
vim.loop.fs_close(fd)
end
---@param filepath string
---@return boolean
local function exists(filepath)
local stat = vim.loop.fs_stat(filepath)
return stat ~= nil and stat.type ~= nil
end
local TmpDir = {}
TmpDir.new = function()
local path, err = vim.loop.fs_mkdtemp('canola_test_XXXXXXXXX')
if not path then
error(err)
end
return setmetatable({ path = path }, {
__index = TmpDir,
})
end
---@param paths string[]
function TmpDir:create(paths)
for _, path in ipairs(paths) do
local pieces = vim.split(path, fs.sep)
local partial_path = self.path
for i, piece in ipairs(pieces) do
partial_path = fs.join(partial_path, piece)
if i == #pieces and not vim.endswith(partial_path, fs.sep) then
touch(partial_path)
elseif not exists(partial_path) then
vim.loop.fs_mkdir(partial_path, 493)
end
end
end
end
---@param filepath string
---@return string?
local read_file = function(filepath)
local fd = vim.loop.fs_open(filepath, 'r', 420)
if not fd then
return nil
end
local stat = vim.loop.fs_fstat(fd)
local content = vim.loop.fs_read(fd, stat.size)
vim.loop.fs_close(fd)
return content
end
---@param dir string
local function walk(dir)
local ret = {}
for name, type in vim.fs.dir(dir) do
table.insert(ret, {
name = name,
type = type,
root = dir,
})
if type == 'directory' then
vim.list_extend(ret, walk(fs.join(dir, name)))
end
end
return ret
end
---@param paths table<string, string>
local assert_fs = function(root, paths)
local unlisted_dirs = {}
for k in pairs(paths) do
local pieces = vim.split(k, '/')
local partial_path = ''
for i, piece in ipairs(pieces) do
partial_path = partial_path .. piece .. '/'
if i ~= #pieces then
unlisted_dirs[partial_path] = true
end
end
end
for k in pairs(unlisted_dirs) do
paths[k] = true
end
local entries = walk(root)
for _, entry in ipairs(entries) do
local fullpath = fs.join(entry.root, entry.name)
local shortpath = fullpath:sub(root:len() + 2)
if entry.type == 'directory' then
shortpath = shortpath .. '/'
end
local expected_content = paths[shortpath]
paths[shortpath] = nil
assert(expected_content, string.format("Unexpected entry '%s'", shortpath))
if entry.type == 'file' then
local data = read_file(fullpath)
assert(
expected_content == data,
string.format(
"File '%s' expected content '%s' received '%s'",
shortpath,
expected_content,
data
)
)
end
end
for k, v in pairs(paths) do
assert(
not k,
string.format(
"Expected %s '%s', but it was not found",
v == true and 'directory' or 'file',
k
)
)
end
end
---@param paths table<string, string>
function TmpDir:assert_fs(paths)
assert_fs(self.path, paths)
end
function TmpDir:assert_exists(path)
path = fs.join(self.path, path)
local stat = vim.loop.fs_stat(path)
assert(stat, string.format("Expected path '%s' to exist", path))
end
function TmpDir:assert_not_exists(path)
path = fs.join(self.path, path)
local stat = vim.loop.fs_stat(path)
assert(not stat, string.format("Expected path '%s' to not exist", path))
end
function TmpDir:dispose()
test_util.await_throwiferr(fs.recursive_delete, 3, 'directory', self.path)
end
return TmpDir