fix: Handle same day date range with times in agenda

Closes #600

Author: kristijanhusak

lua/orgmode/agenda/agenda_item.lua

@@ -150,7 +150,7 @@ function AgendaItem:_is_valid_for_date()
 end
 
 function AgendaItem:_generate_label()
-  local time = not self.headline_date.date_only and add_padding(self.headline_date:format_time()) or ''
+  local time = self.headline_date:has_time() and add_padding(self:_format_time(self.headline_date)) or ''
   if self.headline_date:is_deadline() then
     if self.is_same_day then
       return time .. 'Deadline:'
@@ -187,6 +187,29 @@ function AgendaItem:_generate_label()
   return time
 end
 
+---@private
+---@param date Date
+function AgendaItem:_format_time(date)
+  local formatted_time = date:format_time()
+
+  -- e.g. <2024-09-24 Sun 10:00-11:00>
+  if date:has_time_range() then
+    return formatted_time
+  end
+
+  local date_range_end = date:get_date_range_end()
+
+  -- Format same day date ranges as a time range if the date itself
+  -- does not have a time range (e.g. <2023-09-24 Sun 10:00-11:00)
+  -- example: <2023-09-24 Sun 10:00>--<2023-09-24 Sun 11:00>
+  -- result: 10:00-11:00
+  if date_range_end and date_range_end:is_same(date, 'day') and date_range_end:has_time() then
+    return formatted_time .. '-' .. date_range_end:format_time()
+  end
+
+  return formatted_time
+end
+
 function AgendaItem:_generate_highlight()
   if self.headline_date:is_deadline() then
     if self.headline:is_done() then

lua/orgmode/agenda/views/agenda.lua

@@ -22,26 +22,26 @@ end
 local function sort_agenda_items(agenda_items)
   table.sort(agenda_items, function(a, b)
     if a.is_same_day and b.is_same_day then
-      if not a.real_date.date_only and b.real_date.date_only then
+      if a.real_date:has_time() and not b.real_date:has_time() then
         return true
       end
-      if not b.real_date.date_only and a.real_date.date_only then
+      if b.real_date:has_time() and not a.real_date:has_time() then
         return false
       end
-      if not a.real_date.date_only and not b.real_date.date_only then
+      if a.real_date:has_time() and b.real_date:has_time() then
         return a.real_date:is_before(b.real_date)
       end
       return sort_by_date_or_priority_or_category(a, b)
     end
 
     if a.is_same_day and not b.is_same_day then
-      if not a.real_date.date_only or (b.real_date:is_none() and not a.real_date:is_none()) then
+      if a.real_date:has_time() or (b.real_date:is_none() and not a.real_date:is_none()) then
         return true
       end
     end
 
     if not a.is_same_day and b.is_same_day then
-      if not b.real_date.date_only or (a.real_date:is_none() and not b.real_date:is_none()) then
+      if b.real_date:has_time() or (a.real_date:is_none() and not b.real_date:is_none()) then
         return false
       end
     end

lua/orgmode/objects/date.lua

@@ -317,19 +317,15 @@ end
 
 ---@return string
 function Date:to_string()
-  local date = ''
   local format = date_format
   if self.dayname then
     format = format .. ' %a'
   end
 
-  if self.date_only then
-    date = os.date(format, self.timestamp)
-  else
-    date = os.date(format .. ' ' .. time_format, self.timestamp)
-    if self.timestamp_end then
-      date = date .. '-' .. os.date(time_format, self.timestamp_end)
-    end
+  local date = tostring(os.date(format, self.timestamp))
+
+  if self:has_time() then
+    date = date .. ' ' .. self:format_time()
   end
 
   if #self.adjustments > 0 then
@@ -353,7 +349,7 @@ end
 
 ---@return string
 function Date:format_time()
-  if self.date_only then
+  if not self:has_time() then
     return ''
   end
   local t = self:format(time_format)
@@ -599,6 +595,25 @@ function Date:is_obsolete_range_end()
   return self.is_date_range_end and self.related_date_range:is_same(self, 'day')
 end
 
+---@return boolean
+function Date:has_date_range_end()
+  return self.related_date_range and self.is_date_range_start
+end
+
+function Date:has_time()
+  return not self.date_only
+end
+
+---@return boolean
+function Date:has_time_range()
+  return self.timestamp_end ~= nil
+end
+
+---@return Date|nil
+function Date:get_date_range_end()
+  return self:has_date_range_end() and self.related_date_range or nil
+end
+
 ---Return number of days for a date range
 ---@return number
 function Date:get_date_range_days()

tests/plenary/agenda/agenda_item_spec.lua

@@ -453,64 +453,37 @@ describe('Agenda item', function()
     assert.are.same('10:00...... Scheduled:', agenda_item.label)
   end)
 
-  it('should properly read date ranges bigger than current day', function()
+  it('should properly read same day date ranges and time ranges', function()
+    -- Same day date range
     local range_start = Date.from_string('2021-06-13 Sun 13:30')
-    local range_end = range_start:add({ day = 4, hour = 1 })
+    local range_end = range_start:add({ hour = 1 })
     local headline = generate(string.format('Some text <%s>--<%s>', range_start:to_string(), range_end:to_string()))
     local day = range_start:clone()
     local agenda_item = AgendaItem:new(headline.dates[1], headline, day)
     assert.is.True(agenda_item.is_valid)
-    assert.are.same('13:30...... (1/5):', agenda_item.label)
+    assert.are.same(agenda_item.label, '13:30-14:30 ')
     agenda_item = AgendaItem:new(headline.dates[2], headline, day)
     assert.is.False(agenda_item.is_valid)
 
-    day = day:add({ day = 1 })
-    agenda_item = AgendaItem:new(headline.dates[1], headline, day)
+    -- Time range on a single date
+    local date_with_time_range = Date.from_string('2021-06-13 Sun 15:00-16:30')
+    headline = generate(string.format('Some text <%s>', date_with_time_range:to_string()))
+    agenda_item = AgendaItem:new(headline.dates[1], headline, date_with_time_range)
     assert.is.True(agenda_item.is_valid)
-    assert.are.same('(2/5):', agenda_item.label)
-    agenda_item = AgendaItem:new(headline.dates[2], headline, day)
-    assert.is.False(agenda_item.is_valid)
-
-    day = day:add({ day = 1 })
-    agenda_item = AgendaItem:new(headline.dates[1], headline, day)
-    assert.is.True(agenda_item.is_valid)
-    assert.are.same('(3/5):', agenda_item.label)
-    agenda_item = AgendaItem:new(headline.dates[2], headline, day)
-    assert.is.False(agenda_item.is_valid)
+    assert.are.same(agenda_item.label, '15:00-16:30 ')
 
-    day = day:add({ day = 1 })
-    agenda_item = AgendaItem:new(headline.dates[1], headline, day)
+    -- Time range on a date has precedence over same day date range
+    date_with_time_range = Date.from_string('2021-06-13 Sun 18:00-19:30')
+    local date_with_time_range_end = Date.from_string('2021-06-13 Sun 20:00')
+    headline = generate(string.format('Some text <%s>--<%s>', date_with_time_range:to_string(), date_with_time_range_end:to_string()))
+    agenda_item = AgendaItem:new(headline.dates[1], headline, date_with_time_range)
     assert.is.True(agenda_item.is_valid)
-    assert.are.same('(4/5):', agenda_item.label)
-    agenda_item = AgendaItem:new(headline.dates[2], headline, day)
-    assert.is.False(agenda_item.is_valid)
-
-    day = day:add({ day = 1 })
-    agenda_item = AgendaItem:new(headline.dates[1], headline, day)
-    assert.is.False(agenda_item.is_valid)
-
-    agenda_item = AgendaItem:new(headline.dates[2], headline, day)
-    assert.is.True(agenda_item.is_valid)
-    assert.are.same('14:30...... (5/5):', agenda_item.label)
+    assert.are.same(agenda_item.label, '18:00-19:30 ')
   end)
 
-  it('should ignore end range if it is set to the same day as start day', function()
     local range_start = Date.from_string('2021-06-13 Sun 13:30')
-    local range_end = range_start:add({ hour = 5 })
+    local range_end = range_start:add({ day = 4, hour = 1 })
     local headline = generate(string.format('Some text <%s>--<%s>', range_start:to_string(), range_end:to_string()))
-    local day = range_start:clone()
-    local agenda_item = AgendaItem:new(headline.dates[1], headline, day)
-    assert.is.True(agenda_item.is_valid)
-    assert.are.same('13:30...... ', agenda_item.label)
-    agenda_item = AgendaItem:new(headline.dates[2], headline, day)
-    assert.is.False(agenda_item.is_valid)
-
-    day = day:add({ day = 1 })
-    agenda_item = AgendaItem:new(headline.dates[1], headline, day)
-    assert.is.False(agenda_item.is_valid)
-    agenda_item = AgendaItem:new(headline.dates[2], headline, day)
-    assert.is.False(agenda_item.is_valid)
-  end)
 
   it('should not show scheduled DONE item if disabled in config', function()
     local future_day = Date.now():add({ day = 2 })