Add level and is_archived to OrgHeadline (#437)

Author: joaomsa

lua/orgmode/api/headline.lua

@@ -9,6 +9,7 @@ local Calendar = require('orgmode.objects.calendar')
 ---@class OrgHeadline
 ---@field title string headline title without todo keyword, tags and priority. Ex. `* TODO I am a headline  :SOMETAG:` returns `I am a headline`
 ---@field line string full headline line
+---@field level number headline level (number of asterisks). Example: 1
 ---@field todo_value? string todo keyword of the headline (Example: TODO, DONE)
 ---@field todo_type? string | "'TODO'" | "'DONE'" | "''"
 ---@field tags string[] List of own tags
@@ -21,6 +22,7 @@ local Calendar = require('orgmode.objects.calendar')
 ---@field file OrgFile
 ---@field parent OrgHeadline|nil
 ---@field priority string|nil
+---@field is_archived boolean headline marked with the `:ARCHIVE:` tag
 ---@field headlines OrgHeadline[]
 ---@field private _section Section
 ---@field private _index number
@@ -34,6 +36,7 @@ function OrgHeadline:_new(opts)
   data.todo_value = opts.todo_value
   data.title = opts.title
   data.line = opts.line
+  data.level = opts.level
   data.category = opts.category
   data.position = opts.position
   data.tags = opts.tags
@@ -43,6 +46,7 @@ function OrgHeadline:_new(opts)
   data.scheduled = opts.scheduled
   data.closed = opts.closed
   data.dates = opts.dates
+  data.is_archived = opts.is_archived
   data.parent = opts.parent
   data.headlines = opts.headlines or {}
   data._section = opts._section
@@ -60,6 +64,7 @@ function OrgHeadline._build_from_internal_section(section, index)
   return OrgHeadline:_new({
     title = section.title,
     line = section.line,
+    level = section.level,
     todo_type = section.todo_keyword.type,
     todo_value = section.todo_keyword.value,
     all_tags = { unpack(section.tags) },
@@ -72,6 +77,7 @@ function OrgHeadline._build_from_internal_section(section, index)
       return date:is_none()
     end, section.dates),
     priority = section.priority,
+    is_archived = section:is_archived(),
     _section = section,
     _index = index,
   })

tests/plenary/api/api_spec.lua

@@ -11,7 +11,7 @@ describe('Api', function()
       '  DEADLINE: <2021-07-21 Wed 22:02>',
       '** TODO Second level :NESTEDTAG:',
       '  DEADLINE: <2021-07-21 Wed 22:02>',
-      '* DONE Some task',
+      '* DONE Some task :ARCHIVE:',
       '  DEADLINE: <2021-07-21 Wed 22:02>',
       '  Unrelated date <2022-06-11 Sat 23:15>',
     })
@@ -22,6 +22,7 @@ describe('Api', function()
     assert.are.same(file, current_file.filename)
     assert.are.same(current_file.category, vim.fn.fnamemodify(file, ':p:t:r'))
     assert.are.same(3, #current_file.headlines)
+    assert.are.same(1, current_file.headlines[1].level)
     assert.are.same('Test orgmode', current_file.headlines[1].title)
     assert.are.same('* TODO Test orgmode :WORK:OFFICE:', current_file.headlines[1].line)
     assert.are.same({ 'WORK', 'OFFICE' }, current_file.headlines[1].all_tags)
@@ -38,7 +39,9 @@ describe('Api', function()
     assert.Is.Nil(current_file.headlines[1].scheduled)
     assert.Is.Nil(current_file.headlines[1].closed)
     assert.are.same({}, current_file.headlines[1].dates)
+    assert.Is.False(current_file.headlines[1].is_archived)
 
+    assert.are.same(2, current_file.headlines[2].level)
     assert.are.same('Second level', current_file.headlines[2].title)
     assert.are.same(0, #current_file.headlines[2].headlines)
     assert.are.same({ 'WORK', 'OFFICE', 'NESTEDTAG' }, current_file.headlines[2].all_tags)
@@ -49,12 +52,14 @@ describe('Api', function()
     assert.are.same(1, current_file.headlines[2].position.start_col)
     assert.are.same(6, current_file.headlines[2].position.end_line)
     assert.are.same(0, current_file.headlines[2].position.end_col)
+    assert.Is.False(current_file.headlines[2].is_archived)
     assert.are.same(current_file.headlines[1], current_file.headlines[2].parent)
 
+    assert.are.same(1, current_file.headlines[3].level)
     assert.are.same('Some task', current_file.headlines[3].title)
     assert.are.same(0, #current_file.headlines[3].headlines)
-    assert.are.same({}, current_file.headlines[3].all_tags)
-    assert.are.same({}, current_file.headlines[3].tags)
+    assert.are.same({ 'ARCHIVE' }, current_file.headlines[3].all_tags)
+    assert.are.same({ 'ARCHIVE' }, current_file.headlines[3].tags)
     assert.are.same('DONE', current_file.headlines[3].todo_value)
     assert.are.same('DONE', current_file.headlines[3].todo_type)
     assert.are.same(7, current_file.headlines[3].position.start_line)
@@ -65,6 +70,7 @@ describe('Api', function()
     assert.are.same('2021-07-21 Wed 22:02', current_file.headlines[3].deadline:to_string())
     assert.Is.Nil(current_file.headlines[3].scheduled)
     assert.Is.Nil(current_file.headlines[3].closed)
+    assert.Is.True(current_file.headlines[3].is_archived)
     assert.are.same(1, #current_file.headlines[3].dates)
     assert.are.same('2022-06-11 Sat 23:15', current_file.headlines[3].dates[1]:to_string())
   end)