Add mappings for adding/updating schedule/deadline date. Closes #65.

kristijanhusak · kristijanhusak · commit 5b3c78316034 · 2021-08-18T23:11:00.000+02:00
diff --git a/DOCS.md b/DOCS.md
@@ -572,6 +572,12 @@ Go to previous heading on same level. Doesn't go outside of parent.<br />
 #### **outline_up_heading**
 *mapped to*: `g{`<br />
 Go to parent heading.<br />
+#### **org_deadline**
+*mapped to*: `<Leader>oid`<br />
+Insert/Update deadline date.<br />
+#### **org_schedule**
+*mapped to*: `<Leader>ois`<br />
+Insert/Update scheduled date.<br />
 #### **org_show_help**
 *mapped to*: `?`<br />
 Show help popup with mappings
diff --git a/doc/orgmode.txt b/doc/orgmode.txt
@@ -88,7 +88,9 @@ CONTENTS                                                        *orgmode-content
             1.2.4.27. org_forward_heading_same_level.|orgmode-org_forward_heading_same_level|
             1.2.4.28. org_backward_heading_same_level.|orgmode-org_backward_heading_same_level|
             1.2.4.29. outline_up_heading..............|orgmode-outline_up_heading|
-            1.2.4.30. org_show_help........................|orgmode-org_show_help|
+            1.2.4.30. org_deadline..........................|orgmode-org_deadline|
+            1.2.4.31. org_schedule..........................|orgmode-org_schedule|
+            1.2.4.32. org_show_help........................|orgmode-org_show_help|
     1.3. Autocompletion...................................|orgmode-autocompletion|
     1.4. Abbreviations.....................................|orgmode-abbreviations|
     1.5. Colors...................................................|orgmode-colors|
@@ -787,6 +789,16 @@ OUTLINE_UP_HEADING                                    *orgmode-outline_up_headin
 mapped to: `g{`
 Go to parent heading.
 
+ORG_DEADLINE                                                *orgmode-org_deadline*
+
+mapped to: `<Leader>oid`
+Insert/Update deadline date.
+
+ORG_SCHEDULE                                                *orgmode-org_schedule*
+
+mapped to: `<Leader>ois`
+Insert/Update scheduled date.
+
 ORG_SHOW_HELP                                              *orgmode-org_show_help*
 
 mapped to: `?`
diff --git a/lua/orgmode/config/defaults.lua b/lua/orgmode/config/defaults.lua
@@ -95,6 +95,8 @@ return {
       org_forward_heading_same_level = ']]',
       org_backward_heading_same_level = '[[',
       outline_up_heading = 'g{',
+      org_deadline = '<Leader>oid',
+      org_schedule = '<Leader>ois',
       org_show_help = '?',
     },
   },
diff --git a/lua/orgmode/config/mappings.lua b/lua/orgmode/config/mappings.lua
@@ -51,6 +51,8 @@ return {
     org_forward_heading_same_level = { 'org_mappings.forward_heading_same_level' },
     org_backward_heading_same_level = { 'org_mappings.backward_heading_same_level' },
     outline_up_heading = { 'org_mappings.outline_up_heading' },
+    org_deadline = { 'org_mappings.org_deadline' },
+    org_schedule = { 'org_mappings.org_schedule' },
     org_show_help = { 'org_mappings.show_help' },
   },
 }
diff --git a/lua/orgmode/objects/help.lua b/lua/orgmode/objects/help.lua
@@ -32,6 +32,8 @@ local helps = {
     { key = 'org_forward_heading_same_level', description = 'Go to next heading on same level' },
     { key = 'org_backward_heading_same_level', description = 'Go to previous heading on same level' },
     { key = 'outline_up_heading', description = 'Go to parent heading' },
+    { key = 'org_deadline', description = 'Insert/Update deadline date' },
+    { key = 'org_schedule', description = 'Insert/Update scheduled date' },
     { key = 'org_show_help', description = 'Show this help' },
   },
   orgagenda = {
diff --git a/lua/orgmode/org/mappings.lua b/lua/orgmode/org/mappings.lua
@@ -389,6 +389,28 @@ function OrgMappings:outline_up_heading()
   return vim.fn.cursor(item.parent.range.start_line, 1)
 end
 
+function OrgMappings:org_deadline()
+  local item = Files.get_current_file():get_closest_headline()
+  local deadline_date = item:get_deadline_date()
+  local cb = function(new_date)
+    item:remove_closed_date()
+    item = Files.get_current_file():get_closest_headline()
+    item:add_deadline_date(new_date)
+  end
+  Calendar.new({ callback = cb, date = deadline_date or Date.today() }).open()
+end
+
+function OrgMappings:org_schedule()
+  local item = Files.get_current_file():get_closest_headline()
+  local scheduled_date = item:get_scheduled_date()
+  local cb = function(new_date)
+    item:remove_closed_date()
+    item = Files.get_current_file():get_closest_headline()
+    item:add_scheduled_date(new_date)
+  end
+  Calendar.new({ callback = cb, date = scheduled_date or Date.today() }).open()
+end
+
 ---@param direction string
 ---@param skip_fast_access boolean
 ---@return string
diff --git a/lua/orgmode/parser/headline.lua b/lua/orgmode/parser/headline.lua
@@ -213,6 +213,20 @@ function Headline:get_deadline_and_scheduled_dates()
   end, self.dates)
 end
 
+---@return Date
+function Headline:get_scheduled_date()
+  return vim.tbl_filter(function(date)
+    return date:is_scheduled()
+  end, self.dates)[1]
+end
+
+---@return Date
+function Headline:get_deadline_date()
+  return vim.tbl_filter(function(date)
+    return date:is_deadline()
+  end, self.dates)[1]
+end
+
 function Headline:_get_content_by_lnum(lnum)
   return self.content[lnum - self.range.start_line]
 end
@@ -304,17 +318,25 @@ function Headline:add_closed_date()
   if closed_date then
     return nil
   end
-  local planning = self.content[1]
-  if planning and planning:is_planning() then
-    return vim.api.nvim_call_function('setline', {
-      planning.range.start_line,
-      string.format('%s CLOSED: [%s]', planning.line, Date.now():to_string()),
-    })
+  return self:_add_planning_date(Date.now(), 'CLOSED')
+end
+
+---@param date Date
+function Headline:add_scheduled_date(date)
+  local scheduled_date = self:get_scheduled_date()
+  if scheduled_date then
+    return self:_update_date(scheduled_date, date)
   end
-  return vim.api.nvim_call_function('append', {
-    self.range.start_line,
-    string.format('%sCLOSED: [%s]', string.rep(' ', self.level + 1), Date.now():to_string()),
-  })
+  return self:_add_planning_date(date, 'SCHEDULED', true)
+end
+
+---@param date Date
+function Headline: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 Headline:remove_closed_date()
@@ -457,4 +479,50 @@ function Headline:get_category()
   return self.category
 end
 
+function Headline:_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 Headline:_add_planning_date(date, type, active)
+  local planning = self.content[1]
+  local date_string = string.format('%s%s%s', active and '<' or '[', date:to_string(), active and '>' or ']')
+  if planning and planning:is_planning() then
+    planning.line = string.format('%s %s: %s', planning.line, type, date_string)
+    return vim.api.nvim_call_function('setline', {
+      planning.range.start_line,
+      planning.line,
+    })
+  end
+  local indent = ''
+  if config.org_indent_mode == 'indent' then
+    indent = string.rep(' ', self.level + 1)
+  end
+  return vim.api.nvim_call_function('append', {
+    self.range.start_line,
+    string.format('%s%s: %s', indent, type, date_string),
+  })
+end
+
 return Headline
diff --git a/tests/plenary/org/org_spec.lua b/tests/plenary/org/org_spec.lua
@@ -132,4 +132,82 @@ describe('Org file', function()
     assert.stub(api.nvim_call_function).was.called_with('deletebufline', { 4, 2 })
     mock.revert(api)
   end)
+
+  it('should add and update deadline date', function()
+    local deadline_date = Date.from_string('2021-08-18 Wed')
+    local lines = {
+      '* TODO Test orgmode :WORK:',
+      '* TODO Another todo',
+    }
+    local parsed = parser.parse(lines, 'work')
+    local api = mock(vim.api, true)
+    api.nvim_call_function.returns(true)
+    local headline = parsed:get_item(1)
+    local result = headline:add_deadline_date(deadline_date)
+    assert.are.same(true, result)
+    assert.stub(api.nvim_call_function).was.called_with('append', {
+      1,
+      '  DEADLINE: <2021-08-18 Wed>',
+    })
+    lines = {
+      '* TODO Test orgmode :WORK:',
+      '  DEADLINE: <2021-08-18 Wed>',
+      '* TODO Another todo',
+    }
+    parsed = parser.parse(lines, 'work')
+    headline = parsed:get_item(1)
+    api.nvim_call_function.returns('  DEADLINE: <2021-08-18 Wed>')
+    result = headline:add_deadline_date(deadline_date:add({ day = 2 }))
+    assert.stub(api.nvim_call_function).was.called_with('setline', {
+      2,
+      '  DEADLINE: <2021-08-20 Fri>',
+    })
+    mock.revert(api)
+  end)
+
+  it('should add and update scheduled date', function()
+    local scheduled_date = Date.from_string('2021-08-18 Wed')
+    local lines = {
+      '* TODO Test orgmode :WORK:',
+      '* TODO Another todo',
+    }
+    local parsed = parser.parse(lines, 'work')
+    local api = mock(vim.api, true)
+    api.nvim_call_function.returns(true)
+    local headline = parsed:get_item(1)
+    local result = headline:add_scheduled_date(scheduled_date)
+    assert.are.same(true, result)
+    assert.stub(api.nvim_call_function).was.called_with('append', {
+      1,
+      '  SCHEDULED: <2021-08-18 Wed>',
+    })
+
+    lines = {
+      '* TODO Test orgmode :WORK:',
+      '  DEADLINE: <2021-08-18 Wed>',
+      '* TODO Another todo',
+    }
+    parsed = parser.parse(lines, 'work')
+    headline = parsed:get_item(1)
+    result = headline:add_scheduled_date(scheduled_date:add({ day = 2 }))
+    assert.stub(api.nvim_call_function).was.called_with('setline', {
+      2,
+      '  DEADLINE: <2021-08-18 Wed> SCHEDULED: <2021-08-20 Fri>',
+    })
+
+    lines = {
+      '* TODO Test orgmode :WORK:',
+      '  DEADLINE: <2021-08-18 Wed> SCHEDULED: <2021-08-18 Wed>',
+      '* TODO Another todo',
+    }
+    parsed = parser.parse(lines, 'work')
+    headline = parsed:get_item(1)
+    api.nvim_call_function.returns('  DEADLINE: <2021-08-18 Wed> SCHEDULED: <2021-08-18 Wed>')
+    result = headline:add_scheduled_date(scheduled_date:add({ day = 4 }))
+    assert.stub(api.nvim_call_function).was.called_with('setline', {
+      2,
+      '  DEADLINE: <2021-08-18 Wed> SCHEDULED: <2021-08-22 Sun>',
+    })
+    mock.revert(api)
+  end)
 end)

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,8 @@ return {`
`51`	`51`	`org_forward_heading_same_level = { 'org_mappings.forward_heading_same_level' },`
`52`	`52`	`org_backward_heading_same_level = { 'org_mappings.backward_heading_same_level' },`
`53`	`53`	`outline_up_heading = { 'org_mappings.outline_up_heading' },`
	`54`	`+ org_deadline = { 'org_mappings.org_deadline' },`
	`55`	`+ org_schedule = { 'org_mappings.org_schedule' },`
`54`	`56`	`org_show_help = { 'org_mappings.show_help' },`
`55`	`57`	`},`
`56`	`58`	`}`