Marty/zettelkasten.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Reformat lua code with lua-format

Browse source
This commit is contained in:
Marty Oehme 2020-10-29 19:00:23 +01:00
parent a365cef6c7
commit e5afcb5e15
Signed by: Marty
GPG key ID: B7538B8F50A1C800
4 changed files with 236 additions and 203 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
lua/zettelkasten/init.lua
View file

@ -1,14 +1,17 @@
local ZK = {}
local ls = require'zettelkasten.list'
local ls = require 'zettelkasten.list'
function ZK.init(vimapi)
vim = vimapi or vim
ZK.options = {
anchor_separator = vim.g["zettel_anchor_separator"] or vim.b["zettel_anchor_separator"] or "_",
zettel_extension = vim.g["zettel_extension"] or vim.b["zettel_extension"] or ".md",
zettel_root = vim.g["zettel_root"] or vim.b["zettel_root"] or "~/documents/notes",
}
vim = vimapi or vim
ZK.options = {
anchor_separator = vim.g["zettel_anchor_separator"] or
vim.b["zettel_anchor_separator"] or "_",
zettel_extension = vim.g["zettel_extension"] or
vim.b["zettel_extension"] or ".md"
-- zettel_root = vim.g["zettel_root"] or vim.b["zettel_root"] or "~/documents/notes",
-- TODO zettel_anchor_pattern = regex? -> needs custom creation function in `create_anchor`
}
end
-- entrypoint for pressing the zettel key when the cursor
@ -16,8 +19,8 @@ end
-- follow it) or over text (it will then turn it into a
-- zettel link)
function ZK.follow_link()
assert(false, "NOT IMPLEMENTED")
return ''
assert(false, "NOT IMPLEMENTED")
return ''
end
-- Return a valid zettelkasten anchor,
@ -27,41 +30,41 @@ end
-- and a minute key. Returns nil if the date passed in is invalid.
-- If no date is passed in, returns Zettel anchor for current moment.
function ZK.create_anchor(date)
local timestamp
if pcall(function() timestamp=os.time(date) end) then
return os.date('%y%m%d%H%M', timestamp)
else
return nil
end
local timestamp
if pcall(function() timestamp = os.time(date) end) then
return os.date('%y%m%d%H%M', timestamp)
else
return nil
end
end
-- Returns a link to a markdown file with the date replaced with a zettel anchor,
-- and the text cleaned up to be useful in a link.
function ZK.create_link(text, date)
text = text or ""
local o = ZK.options
if text == "" then
text = "" .. ZK.create_anchor(date)
else
text = text:lower():gsub(" ", "-")
text = "" .. ZK.create_anchor(date) .. o.anchor_separator .. text
end
return text .. (o.zettel_extension or ".md")
text = text or ""
local o = ZK.options
if text == "" then
text = "" .. ZK.create_anchor(date)
else
text = text:lower():gsub(" ", "-")
text = "" .. ZK.create_anchor(date) .. (o.anchor_separator or "_") ..
text
end
return text .. (o.zettel_extension or ".md")
end
-- Returns all zettel in path as a
-- { "anchor" = "path/to/zettel/anchor filename.md" }
-- table.
-- Recurses into subdirectories if recursive argument is true.
function ZK.get_zettel_list(path, recursive)
return ls.get_anchors_and_paths(path, recursive or false)
return ls.get_anchors_and_paths(path, recursive or false)
end
return {
init = ZK.init,
zettel_link_create = ZK.zettel_link_create,
create_anchor = ZK.create_anchor,
create_link = ZK.create_link,
get_zettel_list = ZK.get_zettel_list,
init = ZK.init,
zettel_link_create = ZK.zettel_link_create,
create_anchor = ZK.create_anchor,
create_link = ZK.create_link,
get_zettel_list = ZK.get_zettel_list
}

89
lua/zettelkasten/init_spec.lua
View file

@ -1,53 +1,62 @@
ZK = require'zettelkasten.init'
Test_date={ year=2019, month=10, day=29, hour=16, min=45 }
ZK = require 'zettelkasten.init'
Test_date = {year = 2019, month = 10, day = 29, hour = 16, min = 45}
describe("Zettelkasten", function()
before_each(function()
ZK.init({ g={}, b={} })
end)
before_each(function() ZK.init({g = {}, b = {}}) end)
describe("anchor creation", function()
it("should return zettel anchor from time passed in", function()
assert.same("1910291645", ZK.create_anchor(Test_date))
describe("anchor creation", function()
it("should return zettel anchor from time passed in", function()
assert.same("1910291645", ZK.create_anchor(Test_date))
end)
it(
"should return zettel anchor from current moment if no argument passed in",
function()
assert.same(os.date('%y%m%d%H%M'), ZK.create_anchor())
end)
it("should return nil if argument passed in is invalid", function()
assert.is_nil(ZK.create_anchor("My grandmother is lovely."))
end)
end)
it("should return zettel anchor from current moment if no argument passed in", function()
assert.same(os.date('%y%m%d%H%M'), ZK.create_anchor())
end)
describe("link creation", function()
it(
"should return a markdown link with only zettel anchor on no text passed in",
function()
assert.same("1910291645.md", ZK.create_link(nil, Test_date))
end)
it("should return nil if argument passed in is invalid", function()
assert.is_nil(ZK.create_anchor("My grandmother is lovely."))
end)
end)
it("should text to link", function()
assert.same("1910291645_isappended.md",
ZK.create_link("isappended", Test_date))
end)
describe("link creation", function()
it("should return a markdown link with only zettel anchor on no text passed in", function()
assert.same("1910291645.md", ZK.create_link(nil, Test_date))
end)
it("should return lowercased link text", function()
assert.same("1910291645_yesiamshouting.md",
ZK.create_link("YESIAMSHOUTING", Test_date))
end)
it("should text to link", function()
assert.same("1910291645_isappended.md", ZK.create_link("isappended", Test_date))
end)
it("should return spaces in text replaced with dashes", function()
assert.same("1910291645_yes-indeed-a-space.md",
ZK.create_link("yes indeed a space", Test_date))
end)
it("should return lowercased link text", function()
assert.same("1910291645_yesiamshouting.md", ZK.create_link("YESIAMSHOUTING", Test_date))
end)
it(
"should place the contents of g:zettel_anchor_separator variable in link",
function()
vim = {g = {zettel_anchor_separator = "SEP"}, b = {}}
ZK.init(vim)
assert.same("1910291645SEParated.md",
ZK.create_link("arated", Test_date))
end)
it("should return spaces in text replaced with dashes", function()
assert.same("1910291645_yes-indeed-a-space.md", ZK.create_link("yes indeed a space", Test_date))
it("should append the filetype set in g:zettel_extension", function()
vim = {g = {zettel_extension = ".something"}, b = {}}
ZK.init(vim)
assert.same("1910291645_theworld.something",
ZK.create_link("theworld", Test_date))
end)
end)
it("should place the contents of g:zettel_anchor_separator variable in link", function()
vim = { g = { zettel_anchor_separator = "SEP" }, b = {}}
ZK.init(vim)
assert.same("1910291645SEParated.md", ZK.create_link("arated", Test_date))
end)
it("should append the filetype set in g:zettel_extension", function()
vim = { g = { zettel_extension = ".something" }, b = {}}
ZK.init(vim)
assert.same("1910291645_theworld.something", ZK.create_link("theworld", Test_date))
end)
end)
end)

44
lua/zettelkasten/list.lua
View file

@ -1,36 +1,32 @@
local ls = {}
local function isDirectory(ftype)
if ftype == 'directory' then return true end
return false
if ftype == 'directory' then return true end
return false
end
-- TODO transform paths:
-- * to absolute value (e.g. ~ to home, scandir needs absolute)
-- * to ensure / at the end (or no /) gets taken into account
-- TODO transform paths:
-- * to absolute value (e.g. ~ to home, scandir needs absolute)
-- * to ensure / at the end (or no /) gets taken into account
function ls.get_anchors_and_paths(path, recursive)
-- TODO check for duplicates and warn user
local zettel = {}
local anchorreg = '^.*/?([%d][%d][%d][%d][%d][%d][%d][%d][%d][%d])[^/]*.md$'
-- TODO check for duplicates and warn user
local zettel = {}
local anchorreg = '^.*/?([%d][%d][%d][%d][%d][%d][%d][%d][%d][%d])[^/]*.md$'
local handle = vim.loop.fs_scandir(path)
while handle do
local name, ftype = vim.loop.fs_scandir_next(handle)
if not name then break end
local handle = vim.loop.fs_scandir(path)
while handle do
local name, ftype = vim.loop.fs_scandir_next(handle)
if not name then break end
if isDirectory(ftype) and recursive then
local subdir = ls.get_anchors_and_paths(path .. "/" .. name, true)
for k, v in pairs(subdir) do
zettel[tostring(k)] = v
end
if isDirectory(ftype) and recursive then
local subdir = ls.get_anchors_and_paths(path .. "/" .. name, true)
for k, v in pairs(subdir) do zettel[tostring(k)] = v end
end
local anchor = string.match(name, anchorreg)
if anchor then zettel[tostring(anchor)] = name end
end
local anchor = string.match(name, anchorreg)
if anchor then
zettel[tostring(anchor)] = name
end
end
return zettel
return zettel
end
return ls

241
lua/zettelkasten/list_spec.lua
View file

@ -1,114 +1,139 @@
ZK = require'zettelkasten.init'
ZK = require 'zettelkasten.init'
-- these tests, I suppose, only work on unix due to the file structure
describe("zettel listing", function()
before_each(function()
get_api_mock = function(files)
return {
g = {},
b = {},
loop = {
fs_scandir = function()
if #files == 0 then
return false
else
return true
end
end,
fs_scandir_next = function() return table.remove(files) end
}
}
end
end)
it("should return anchor-keyed table pointing to filename of zettel", function()
local file_list = { "1910291645 this-is-a-testfile.md" }
ZK.init(get_api_mock(file_list))
local expected = { ["1910291645"] = "1910291645 this-is-a-testfile.md", }
assert.same(expected, ZK.get_zettel_list("someDir"))
end)
it("should ignore any malformed files", function()
local file_list = {
"2010261208 this-should-be-picked-up.md",
"1910291645 this-is-a-testfile.md",
"this-is-not-a-testfile.md",
"1910271456 this-is-wrong-extension.txt",
"1812 this-is-ignored.md",
}
ZK.init(get_api_mock(file_list))
local expected = {
["1910291645"] = "1910291645 this-is-a-testfile.md",
["2010261208"] = "2010261208 this-should-be-picked-up.md",
}
assert.same(expected, ZK.get_zettel_list("someDir"))
end)
it("should recurse into directories if recursive argument passed in ", function()
local files = {
{ "1910271456 testfile.md", "file" },
{ "more-notes-here", "directory" },
{ "2010261208 another-testfile.md", "file" },
}
local vim_api_mock = {
g = {},
b = {},
loop = mock({
fs_scandir = function()
if #files == 0 then
return false
else
return true
end
end,
fs_scandir_next = function()
if #files == 0 then return nil end
local fname, ftype = unpack(table.remove(files))
return fname, ftype
end
})
}
ZK.init(vim_api_mock)
ZK.get_zettel_list("path/to/startingdir", true)
assert.spy(vim_api_mock.loop.fs_scandir).was_called(2)
assert.spy(vim_api_mock.loop.fs_scandir).was_called_with("path/to/startingdir/more-notes-here")
end)
it("should append all notes found in subdirectories when recursing", function()
local outer_files = { "subdir", "1234567890 myfile.md", "2345678901 another.md", }
local inner_files = { "2222222222 should-be-present.md", "3333333333 should-also-be-present.md" }
local files = outer_files
-- assert.is_true("not implemented")
local vim_api_mock = {
g = {},
b = {},
loop ={
fs_scandir = function()
if #files == 0 then return false end
return true
end,
fs_scandir_next = function()
if #files == 0 then return nil end
local fname, ftype = table.remove(files), 'file'
if fname == "subdir" then
files = inner_files
ftype = 'directory'
end
return fname, ftype
before_each(function()
get_api_mock = function(files)
return {
g = {},
b = {},
loop = {
fs_scandir = function()
if #files == 0 then
return false
else
return true
end
end,
fs_scandir_next = function()
return table.remove(files)
end
}
}
end
}}
ZK.init(vim_api_mock)
local expected = {
["1234567890"] = "1234567890 myfile.md",
["2345678901"] = "2345678901 another.md",
["2222222222"] = "2222222222 should-be-present.md",
["3333333333"] = "3333333333 should-also-be-present.md",
}
assert.same(expected, ZK.get_zettel_list('mydirectory', true))
end)
end)
it("should return anchor-keyed table pointing to filename of zettel",
function()
local file_list = {"1910291645 this-is-a-testfile.md"}
ZK.init(get_api_mock(file_list))
local expected = {["1910291645"] = "1910291645 this-is-a-testfile.md"}
assert.same(expected, ZK.get_zettel_list("someDir"))
end)
it("should ignore any malformed files", function()
local file_list = {
"2010261208 this-should-be-picked-up.md",
"1910291645 this-is-a-testfile.md", "this-is-not-a-testfile.md",
"1910271456 this-is-wrong-extension.txt", "1812 this-is-ignored.md"
}
ZK.init(get_api_mock(file_list))
local expected = {
["1910291645"] = "1910291645 this-is-a-testfile.md",
["2010261208"] = "2010261208 this-should-be-picked-up.md"
}
assert.same(expected, ZK.get_zettel_list("someDir"))
end)
it("should recurse into directories if recursive argument passed in ",
function()
local files = {
{"1910271456 testfile.md", "file"},
{"more-notes-here", "directory"},
{"2010261208 another-testfile.md", "file"}
}
local vim_api_mock = {
g = {},
b = {},
loop = mock({
fs_scandir = function()
if #files == 0 then
return false
else
return true
end
end,
fs_scandir_next = function()
if #files == 0 then return nil end
local fname, ftype = unpack(table.remove(files))
return fname, ftype
end
})
}
ZK.init(vim_api_mock)
ZK.get_zettel_list("path/to/startingdir", true)
assert.spy(vim_api_mock.loop.fs_scandir).was_called(2)
assert.spy(vim_api_mock.loop.fs_scandir).was_called_with(
"path/to/startingdir/more-notes-here")
end)
it("should append all notes found in subdirectories when recursing",
function()
local outer_files = {
"subdir", "1234567890 myfile.md", "2345678901 another.md"
}
local inner_files = {
"2222222222 should-be-present.md",
"3333333333 should-also-be-present.md"
}
local files = outer_files
-- assert.is_true("not implemented")
local vim_api_mock = {
g = {},
b = {},
loop = {
fs_scandir = function()
if #files == 0 then return false end
return true
end,
fs_scandir_next = function()
if #files == 0 then return nil end
local fname, ftype = table.remove(files), 'file'
if fname == "subdir" then
files = inner_files
ftype = 'directory'
end
return fname, ftype
end
}
}
ZK.init(vim_api_mock)
local expected = {
["1234567890"] = "1234567890 myfile.md",
["2345678901"] = "2345678901 another.md",
["2222222222"] = "2222222222 should-be-present.md",
["3333333333"] = "3333333333 should-also-be-present.md"
}
assert.same(expected, ZK.get_zettel_list('mydirectory', true))
end)
it("should adhere to the zettel extension defined in options", function()
local file_list = {"1910291645 myfile.wiki", "2345678901 another.wiki"}
local vim = get_api_mock(file_list)
vim.g['zettel_extension'] = '.wiki'
ZK.init(vim)
local expected = {
["1910291645"] = "1910291645 myfile.wiki",
["2345678901"] = "2345678901 another.wiki"
}
assert.same(expected, ZK.get_zettel_list('mydirectory'))
end)
end)