feat(files): Add method to append file to paths

Author: kristijanhusak

lua/orgmode/files/init.lua

@@ -14,17 +14,17 @@ local Listitem = require('orgmode.files.elements.listitem')
 ---@field all_files table<string, OrgFile> all loaded files, no matter if they are part of paths
 ---@field load_state 'loading' | 'loaded' | nil
 local OrgFiles = {}
+OrgFiles.__index = OrgFiles
 
 ---@param opts OrgFilesOpts
 function OrgFiles:new(opts)
   local data = {
-    paths = opts.paths or {},
     files = {},
     all_files = {},
     load_state = nil,
   }
   setmetatable(data, self)
-  self.__index = self
+  self.paths = self:_setup_paths(opts.paths)
   return data
 end
 
@@ -54,6 +54,36 @@ function OrgFiles:load(force)
   end)
 end
 
+---@param filename string
+---@return OrgPromise<OrgFile>
+function OrgFiles:add_to_paths(filename)
+  filename = vim.fs.normalize(filename)
+
+  if self.files[filename] then
+    return self.files[filename]:reload()
+  end
+
+  local promise = self:load_file(filename):next(function(orgfile)
+    if orgfile then
+      self.files[filename] = orgfile
+      local all_paths = self:_files()
+      if not vim.tbl_contains(all_paths, filename) then
+        table.insert(self.paths, filename)
+      end
+    end
+    return orgfile
+  end)
+
+  return promise
+end
+
+---@param filename string
+---@param timeout? number
+---@return OrgFile
+function OrgFiles:add_to_paths_sync(filename, timeout)
+  return self:add_to_paths(filename):wait(timeout)
+end
+
 function OrgFiles:get_tags()
   local tags = {}
   for _, orgfile in ipairs(self:all()) do
@@ -295,23 +325,29 @@ function OrgFiles:ensure_loaded()
 end
 
 ---@private
-function OrgFiles:_files()
-  local all_filenames = {}
-  local files = self.paths
-  if not files or files == '' or (type(files) == 'table' and vim.tbl_isempty(files)) then
-    return all_filenames
+---@param paths string | string[] | nil
+---@return string[]
+function OrgFiles:_setup_paths(paths)
+  if not paths or paths == '' or (type(paths) == 'table' and vim.tbl_isempty(paths)) then
+    return {}
   end
-  if type(files) ~= 'table' then
-    files = { files }
+
+  if type(paths) ~= 'table' then
+    return { paths }
   end
 
+  return paths
+end
+
+---@private
+function OrgFiles:_files()
   local all_files = vim.tbl_map(function(file)
     return vim.tbl_map(function(path)
       return vim.fn.resolve(path)
     end, vim.fn.glob(vim.fn.fnamemodify(file, ':p'), false, true))
-  end, files)
+  end, self.paths)
 
-  all_files = utils.concat(vim.tbl_flatten(all_files), all_filenames, true)
+  all_files = vim.tbl_flatten(all_files)
 
   return vim.tbl_filter(function(file)
     local ext = vim.fn.fnamemodify(file, ':e')

tests/plenary/init_spec.lua

@@ -1,15 +1,16 @@
+local helpers = require('tests.plenary.helpers')
 local orgmode = require('orgmode')
 
 describe('Init', function()
+  local org = orgmode.setup({
+    org_agenda_files = vim.fn.getcwd() .. '/tests/plenary/fixtures/*',
+    org_default_notes_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/refile.org',
+  })
+  local todo_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/todo.org'
+  local todo_archive_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/todo.org_archive'
+  local refile_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/refile.org'
+  local txt_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/text_notes.txt'
   it('should load and parse files from folder', function()
-    local org = orgmode.setup({
-      org_agenda_files = vim.fn.getcwd() .. '/tests/plenary/fixtures/*',
-      org_default_notes_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/refile.org',
-    })
-    local todo_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/todo.org'
-    local todo_archive_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/todo.org_archive'
-    local refile_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/refile.org'
-    local txt_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/text_notes.txt'
     assert.is.Nil(rawget(org, 'files'))
     assert.is.Nil(rawget(org, 'agenda'))
     assert.is.Nil(rawget(org, 'capture'))
@@ -34,4 +35,22 @@ describe('Init', function()
     assert.are.same(true, org.files:get(todo_archive_file):is_archive_file())
     assert.are.same({ 'NESTED', 'OFFICE', 'PRIVATE', 'PROJECT', 'WORK' }, org.files:get_tags())
   end)
+
+  it('should append files to paths', function()
+    local fname = vim.fn.tempname() .. '.org'
+    vim.fn.writefile({ '* Appended' }, fname)
+
+    assert.is.Nil(org.files.files[fname])
+    assert.are.same({}, org.files:find_headlines_by_title('Appended'))
+    assert.are.same({ vim.fn.getcwd() .. '/tests/plenary/fixtures/*' }, org.files.paths)
+
+    org.files:add_to_paths_sync(fname)
+    assert.is.Not.Nil(org.files.files[fname])
+    assert.are.same('Appended', org.files:find_headlines_by_title('Appended')[1]:get_title())
+    assert.are.same({ vim.fn.getcwd() .. '/tests/plenary/fixtures/*', fname }, org.files.paths)
+
+    org.files:add_to_paths_sync(todo_file)
+    -- Existing file in path not appended to paths
+    assert.are.same({ vim.fn.getcwd() .. '/tests/plenary/fixtures/*', fname }, org.files.paths)
+  end)
 end)