refactor: Add "update" method to file instance

Author: kristijanhusak

lua/orgmode/capture/init.lua

@@ -180,19 +180,17 @@ function Capture:_refile_from_capture_buffer(opts)
 
   lines = opts.template:apply_properties_to_lines(lines)
 
-  self.files
-    :update_file(destination_file.filename, function(file)
-      if not destination_headline and opts.template.regexp then
-        local line = vim.fn.search(opts.template.regexp, 'ncw')
-        if line > 0 then
-          return vim.api.nvim_buf_set_lines(file:bufnr(), line, line, false, lines)
-        end
+  destination_file:update_sync(function(file)
+    if not destination_headline and opts.template.regexp then
+      local line = vim.fn.search(opts.template.regexp, 'ncw')
+      if line > 0 then
+        return vim.api.nvim_buf_set_lines(file:bufnr(), line, line, false, lines)
       end
+    end
 
-      local range = self:_get_destination_range_without_empty_lines(Range.from_line(target_line))
-      vim.api.nvim_buf_set_lines(file:bufnr(), range.start_line, range.end_line, false, lines)
-    end)
-    :wait()
+    local range = self:_get_destination_range_without_empty_lines(Range.from_line(target_line))
+    vim.api.nvim_buf_set_lines(file:bufnr(), range.start_line, range.end_line, false, lines)
+  end)
 
   if self.on_post_refile then
     self.on_post_refile(self, opts)
@@ -235,18 +233,16 @@ function Capture:_refile_from_org_file(opts)
     lines = self:_adapt_headline_level(source_headline, target_level, is_same_file)
   end
 
-  self.files
-    :update_file(destination_file.filename, function()
-      if is_same_file then
-        local item_range = source_headline:get_range()
-        return vim.cmd(string.format('silent! %d,%d move %s', item_range.start_line, item_range.end_line, target_line))
-      end
+  destination_file:update_sync(function(file)
+    if is_same_file then
+      local item_range = source_headline:get_range()
+      return vim.cmd(string.format('silent! %d,%d move %s', item_range.start_line, item_range.end_line, target_line))
+    end
 
-      local range = self:_get_destination_range_without_empty_lines(Range.from_line(target_line))
-      target_line = range.start_line
-      vim.api.nvim_buf_set_lines(0, range.start_line, range.end_line, false, lines)
-    end)
-    :wait()
+    local range = self:_get_destination_range_without_empty_lines(Range.from_line(target_line))
+    target_line = range.start_line
+    vim.api.nvim_buf_set_lines(0, range.start_line, range.end_line, false, lines)
+  end)
 
   if not is_same_file and source_file.filename == utils.current_file_path() then
     local item_range = source_headline:get_range()
@@ -287,7 +283,7 @@ function Capture:refile_file_headline_to_archive(headline)
   })
 
   destination_file = self.files:get(archive_location)
-  self.files:update_file(destination_file.filename, function(archive_file)
+  destination_file:update(function(archive_file)
     local archived_headline = archive_file:get_closest_headline({ target_line, 0 })
     archived_headline:set_property('ARCHIVE_TIME', Date.now():to_string())
     archived_headline:set_property('ARCHIVE_FILE', file.filename)

lua/orgmode/capture/template/datetree.lua

@@ -20,11 +20,9 @@ function Datetree:create(template)
   local result = self:_get_datetree_destination(template)
 
   if result.create then
-    self.files
-      :update_file(destination_file.filename, function(file)
-        vim.api.nvim_buf_set_lines(file:bufnr(), result.target_line, result.target_line, false, result.content)
-      end)
-      :wait()
+    destination_file:update_sync(function(file)
+      vim.api.nvim_buf_set_lines(file:bufnr(), result.target_line, result.target_line, false, result.content)
+    end)
     destination_file = destination_file:reload_sync()
   end
 

lua/orgmode/clock/init.lua

@@ -39,10 +39,9 @@ function Clock:org_clock_in()
   local promise = Promise.resolve()
 
   if self.clocked_headline and self.clocked_headline:is_clocked_in() then
-    local filename = self.clocked_headline.file.filename
-    promise = self.files:update_file(filename, function()
-      local clocked_item =
-        self.files:get(filename):get_closest_headline({ self.clocked_headline:get_range().start_line, 0 })
+    local file = self.clocked_headline.file
+    promise = file:update(function()
+      local clocked_item = file:reload_sync():get_closest_headline({ self.clocked_headline:get_range().start_line, 0 })
       clocked_item:clock_out()
     end)
   end

lua/orgmode/files/file.lua

@@ -103,6 +103,32 @@ function OrgFile:reload_sync(timeout)
   return self:reload():wait(timeout)
 end
 
+---@param action fun(...:OrgFile):any
+function OrgFile:update(action)
+  local is_same_file = self.filename == utils.current_file_path()
+  if is_same_file then
+    return Promise.resolve(action(self)):next(function(result)
+      vim.cmd(':silent! w')
+      return result
+    end)
+  end
+
+  local edit_file = utils.edit_file(self.filename)
+  edit_file.open()
+
+  return Promise.resolve(action(self)):next(function(result)
+    edit_file.close()
+    return self:reload():next(function()
+      return result
+    end)
+  end)
+end
+
+---@param action fun(...:OrgFile):any
+function OrgFile:update_sync(action, timeout)
+  return self:update(action):wait(timeout)
+end
+
 ---Check if file has been modified via 2 methods:
 ---1. If file is loaded in a buffer, check the changedtick
 ---2. If file is not loaded in a buffer, check the mtime

lua/orgmode/files/init.lua

@@ -296,23 +296,7 @@ function OrgFiles:update_file(filename, action)
   if not file then
     return Promise.resolve()
   end
-  local is_same_file = filename == utils.current_file_path()
-  if is_same_file then
-    return Promise.resolve(action(file)):next(function(result)
-      vim.cmd(':silent! w')
-      return result
-    end)
-  end
-
-  local edit_file = utils.edit_file(filename)
-  edit_file.open()
-
-  return Promise.resolve(action(file)):next(function(result)
-    edit_file.close()
-    return file:reload():next(function()
-      return result
-    end)
-  end)
+  return file:update(action)
 end
 
 function OrgFiles:ensure_loaded()