refactor: use treesitter to set plan dates

Author: kristijanhusak

lua/orgmode/events/types/todo_changed_event.lua

@@ -11,7 +11,7 @@ local TodoChangedEvent = {
 ---@param section Section
 ---@param headline Headline
 ---@param old_todo_state? string
----@param is_done? string
+---@param is_done? boolean
 function TodoChangedEvent:new(section, headline, old_todo_state, is_done)
   local obj = setmetatable({}, self)
   self.__index = self

lua/orgmode/org/mappings.lua

@@ -50,7 +50,7 @@ function OrgMappings:archive()
     archive_location,
     vim.schedule_wrap(function()
       Files.update_file(archive_location, function()
-        local archived_headline = ts_org.find_headline(item.title, true)
+        local archived_headline = ts_org.find_headline_by_title(item.title, true)
         if archived_headline then
           archived_headline:set_property('ARCHIVE_TIME', Date.now():to_string())
           archived_headline:set_property('ARCHIVE_FILE', file.filename)
@@ -396,7 +396,7 @@ function OrgMappings:_todo_change_state(direction)
   local log_note = config.org_log_done == 'note'
   local log_time = config.org_log_done == 'time'
   local should_log_time = log_note or log_time
-  local indent = config:get_indent(item.level + 1)
+  local indent = config:get_indent(headline:level() + 1)
 
   local get_note = function(note)
     if note == nil then
@@ -414,15 +414,16 @@ function OrgMappings:_todo_change_state(direction)
   local repeater_dates = item:get_repeater_dates()
   if #repeater_dates == 0 then
     if should_log_time and item:is_done() and not was_done then
-      headline:add_closed_date()
+      headline:set_closed_date()
       item = Files.get_closest_headline()
 
       if log_note then
         dispatchEvent()
         return self.capture.closing_note:open():next(function(note)
           local valid_note = get_note(note)
           if valid_note then
-            vim.fn.append(item:get_todo_note_line_number(), valid_note)
+            local append_line = headline:get_append_line()
+            vim.api.nvim_buf_set_lines(0, append_line, append_line, false, valid_note)
           end
         end)
       end
@@ -458,8 +459,8 @@ function OrgMappings:_todo_change_state(direction)
       if not note then
         return
       end
-      local properties_end_line = headline:properties():end_()
-      vim.api.nvim_buf_set_lines(0, properties_end_line, properties_end_line, false, note)
+      local append_line = headline:get_append_line()
+      vim.api.nvim_buf_set_lines(0, append_line, append_line, false, note)
     end)
 end
 

lua/orgmode/parser/section.lua

@@ -321,67 +321,6 @@ function Section:get_repeater_dates()
   end, self.dates)
 end
 
----@deprecated use treesitter.headline.set_property
----@param properties table
----@return table
-function Section:add_properties(properties)
-  if self.properties.valid then
-    local start = vim.api.nvim_call_function('getline', { self.properties.range.start_line })
-    local indent = start:match('^%s*')
-    for name, val in pairs(properties) do
-      if self.properties.items[name:lower()] then
-        local properties_content = self.root:get_node_text_list(self.properties.node)
-        for i, content in ipairs(properties_content) do
-          if content:lower():match('^%s*:' .. name:lower() .. ':.*$') then
-            local new_line = content:gsub(vim.pesc(self.properties.items[name:lower()]), val)
-            vim.api.nvim_call_function('setline', { self.properties.range.start_line + i - 1, new_line })
-            break
-          end
-        end
-      else
-        vim.api.nvim_call_function('append', {
-          self.properties.range.start_line,
-          string.format('%s:%s: %s', indent, name, val),
-        })
-      end
-    end
-    return {
-      is_new = false,
-      indent = indent,
-    }
-  end
-
-  local properties_line = self:get_content_start_line_number()
-  local indent = config:get_indent(self.level + 1)
-  local content = { string.format('%s:PROPERTIES:', indent) }
-
-  for name, val in pairs(properties) do
-    table.insert(content, string.format('%s:%s: %s', indent, name, val))
-  end
-
-  table.insert(content, string.format('%s:END:', indent))
-  vim.api.nvim_call_function('append', { properties_line, content })
-  return {
-    is_new = true,
-    end_line = properties_line + #content,
-    indent = indent,
-  }
-end
-
-function Section:get_content_start_line_number()
-  if self:has_planning() then
-    return self.range.start_line + 1
-  end
-  return self.range.start_line
-end
-
-function Section:get_todo_note_line_number()
-  if self.properties.valid then
-    return self.properties.range.end_line
-  end
-  return self:get_content_start_line_number()
-end
-
 ---@return boolean
 function Section:is_first_section()
   if not self.parent then
@@ -494,46 +433,6 @@ function Section:promote(amount, promote_child_sections)
   end
 end
 
-function Section:add_closed_date()
-  local closed_date = self:get_closed_date()
-  if closed_date then
-    return nil
-  end
-  return self:_add_planning_date(Date.now(), 'CLOSED')
-end
-
----@param date Date
-function Section:add_scheduled_date(date)
-  local scheduled_date = self:get_scheduled_date()
-  if scheduled_date then
-    return self:_update_date(scheduled_date, date)
-  end
-  return self:_add_planning_date(date, 'SCHEDULED', true)
-end
-
----@param date Date
-function Section:add_deadline_date(date)
-  local deadline_date = self:get_deadline_date()
-  if deadline_date then
-    return self:_update_date(deadline_date, date)
-  end
-  return self:_add_planning_date(date, 'DEADLINE', true)
-end
-
-function Section:remove_closed_date()
-  local closed_date = self:get_closed_date()
-  if not closed_date then
-    return nil
-  end
-  local planning_linenr = self.range.start_line + 1
-  local planning_line = vim.api.nvim_call_function('getline', { planning_linenr })
-  local new_line = planning_line:gsub('%s*CLOSED:%s*[%[<]' .. vim.pesc(closed_date:to_string()) .. '[%]>]', '')
-  if vim.trim(new_line) == '' then
-    return vim.api.nvim_call_function('deletebufline', { vim.api.nvim_get_current_buf(), planning_linenr })
-  end
-  return vim.api.nvim_call_function('setline', { planning_linenr, new_line })
-end
-
 ---@return boolean
 function Section:has_planning()
   for _, date in ipairs(self.dates) do
@@ -619,43 +518,4 @@ function Section:get_title()
   return title
 end
 
-function Section:_update_date(date, new_date)
-  date = date:set({
-    year = new_date.year,
-    month = new_date.month,
-    day = new_date.day,
-  })
-  local line = vim.api.nvim_call_function('getline', { date.range.start_line })
-  local view = vim.fn.winsaveview()
-  local new_line =
-    string.format('%s%s%s', line:sub(1, date.range.start_col), date:to_string(), line:sub(date.range.end_col))
-  vim.api.nvim_call_function('setline', {
-    date.range.start_line,
-    new_line,
-  })
-  vim.fn.winrestview(view)
-  return true
-end
-
----@param date Date
----@param type string
----@param active? boolean
----@return string
-function Section:_add_planning_date(date, type, active)
-  local date_string = date:to_wrapped_string(active)
-  if self:has_planning() then
-    local planning_linenr = self.range.start_line + 1
-    return vim.api.nvim_call_function('setline', {
-      planning_linenr,
-      string.format('%s %s: %s', vim.api.nvim_call_function('getline', { planning_linenr }), type, date_string),
-    })
-  end
-
-  local indent = config:get_indent(self.level + 1)
-  return vim.api.nvim_call_function('append', {
-    self.range.start_line,
-    string.format('%s%s: %s', indent, type, date_string),
-  })
-end
-
 return Section

lua/orgmode/treesitter/headline.lua

@@ -150,8 +150,9 @@ end
 -- and if it's in done state
 -- @return Node, string, boolean
 function Headline:todo()
-  local keywords = config.todo_keywords.ALL
-  local done_keywords = config.todo_keywords.DONE
+  local todo_keywords = config:get_todo_keywords()
+  local keywords = todo_keywords.ALL
+  local done_keywords = todo_keywords.DONE
 
   -- A valid keyword can only be the first child
   local todo_node = self:item():named_child(0)
@@ -170,6 +171,35 @@ function Headline:todo()
   end
 end
 
+function Headline:todo_keyword()
+  local node, word = self:todo()
+  if not node then
+    return {
+      value = '',
+      type = '',
+      node = nil,
+    }
+  end
+
+  local todo_keywords = config:get_todo_keywords()
+  return {
+    value = word,
+    type = todo_keywords.KEYS[word].type,
+    node = node,
+  }
+end
+
+---@return boolean
+function Headline:is_todo()
+  local _, _, is_done = self:todo()
+  return not is_done
+end
+
+---@return boolean
+function Headline:is_done()
+  return not self:is_todo()
+end
+
 function Headline:title()
   local title = query.get_node_text(self:item(), 0) or ''
   local todo, word = self:todo()
@@ -179,7 +209,7 @@ function Headline:title()
   return title
 end
 
----@return userdata
+---@return userdata|nil
 function Headline:plan()
   local section = self.headline:parent()
   for _, node in ipairs(ts_utils.get_named_children(section)) do
@@ -189,7 +219,7 @@ function Headline:plan()
   end
 end
 
----@return userdata
+---@return userdata|nil
 function Headline:properties()
   local section = self.headline:parent()
   for _, node in ipairs(ts_utils.get_named_children(section)) do
@@ -306,12 +336,13 @@ function Headline:set_scheduled_date(date)
   return self:_add_date('SCHEDULED', date, true)
 end
 
-function Headline:add_closed_date()
+---@param date? Date
+function Headline:set_closed_date(date)
   local dates = self:dates()
   if dates['CLOSED'] then
     return
   end
-  return self:_add_date('CLOSED', Date.now(), false)
+  return self:_add_date('CLOSED', date or Date.now(), false)
 end
 
 function Headline:remove_closed_date()
@@ -401,13 +432,12 @@ function Headline:_add_date(type, date, active)
   if vim.tbl_isempty(dates) then
     local indent = config:get_indent(self:level() + 1)
     local start_line = self.headline:start()
-    return vim.api.nvim_call_function('append', {
-      start_line + 1,
-      string.format('%s%s', indent, text),
-    })
+    vim.fn.append(start_line + 1, ('%s%s'):format(indent, text))
+    return self:refresh()
   end
   if dates[type] then
-    return tree_utils.set_node_text(dates[type], text, true)
+    tree_utils.set_node_text(dates[type], text, true)
+    return self:refresh()
   end
 
   local keys = vim.tbl_keys(dates)
@@ -423,6 +453,7 @@ function Headline:_add_date(type, date, active)
   end
   local ptext = query.get_node_text(last_child, 0)
   tree_utils.set_node_text(last_child, ptext .. ' ' .. text)
+  return self:refresh()
 end
 
 ---@param type string | "DEADLINE" | "SCHEDULED" | "CLOSED"
@@ -435,8 +466,9 @@ function Headline:_remove_date(type)
   local line_nr = dates[type]:start() + 1
   tree_utils.set_node_text(dates[type], '', true)
   if vim.trim(vim.fn.getline(line_nr)) == '' then
-    return vim.api.nvim_call_function('deletebufline', { vim.api.nvim_get_current_buf(), line_nr })
+    vim.fn.deletebufline(vim.api.nvim_get_current_buf(), line_nr)
   end
+  return self:refresh()
 end
 
 ---@param text table|string