Fix broken priority cycling (#418)

Author: jgollenz

lua/orgmode/config/init.lua

@@ -34,10 +34,95 @@ function Config:extend(opts)
   self.todo_keywords = nil
   opts = opts or {}
   self:_deprecation_notify(opts)
+  if not self:_are_priorities_valid(opts) then
+    opts.org_priority_highest = self.opts.org_priority_highest
+    opts.org_priority_lowest = self.opts.org_priority_lowest
+    opts.org_priority_default = self.opts.org_priority_default
+  end
   self.opts = vim.tbl_deep_extend('force', self.opts, opts)
   return self
 end
 
+function Config:_are_priorities_valid(opts)
+  local high = opts.org_priority_highest
+  local low = opts.org_priority_lowest
+  local default = opts.org_priority_default
+
+  if high or low or default then
+    -- assert that all three options are set
+    if not (high and low and default) then
+      utils.echo_warning(
+        'org_priority_highest, org_priority_lowest and org_priority_default can only be set together.'
+          .. 'Falling back to default priorities'
+      )
+      return false
+    end
+
+    -- numbers
+    if type(high) == 'number' and type(low) == 'number' and type(default) == 'number' then
+      if high < 0 or low < 0 or default < 0 then
+        utils.echo_warning(
+          'org_priority_highest, org_priority_lowest and org_priority_default cannot be negative.'
+            .. 'Falling back to default priorities'
+        )
+        return false
+      end
+      if high > low then
+        utils.echo_warning(
+          'org_priority_highest cannot be bigger than org_priority_lowest. Falling back to default priorities'
+        )
+        return false
+      end
+      if default < high or default > low then
+        utils.echo_warning(
+          'org_priority_default must be bigger than org_priority_highest and smaller than org_priority_lowest.'
+            .. 'Falling back to default priorities'
+        )
+        return false
+      end
+    -- one-char strings
+    elseif
+      (type(high) == 'string' and #high == 1)
+      and (type(low) == 'string' and #low == 1)
+      and (type(default) == 'string' and #default == 1)
+    then
+      if not high:match('%a') or not low:match('%a') or not default:match('%a') then
+        utils.echo_warning(
+          'org_priority_highest, org_priority_lowest and org_priority_default must be letters.'
+            .. 'Falling back to default priorities'
+        )
+        return false
+      end
+
+      high = string.byte(high)
+      low = string.byte(low)
+      default = string.byte(default)
+      if high > low then
+        utils.echo_warning(
+          'org_priority_highest cannot be bigger than org_priority_lowest. Falling back to default priorities'
+        )
+        return false
+      end
+      if default < high or default > low then
+        utils.echo_warning(
+          'org_priority_default must be bigger than org_priority_highest and smaller than org_priority_lowest.'
+            .. 'Falling back to default priorities'
+        )
+        return false
+      end
+    else
+      utils.echo_warning(
+        'org_priority_highest, org_priority_lowest and org_priority_default must be either of type'
+          .. "'number' or of type 'string' of length one. All three options need to agree on this type."
+          .. 'Falling back to default priorities'
+      )
+      return false
+    end
+  end
+
+  return true
+end
+
 function Config:_deprecation_notify(opts)
   local messages = {}
   if

lua/orgmode/objects/priority_state.lua

@@ -81,6 +81,9 @@ end
 ---@param direction number
 ---@return string
 function PriorityState:_apply(direction)
+  if type(tonumber(self.priority)) == 'number' then
+    return tostring(tonumber(self.priority) + direction)
+  end
   return string.char(string.byte(self.priority) + direction)
 end
 

tests/plenary/object/priority_state_spec.lua

@@ -12,22 +12,22 @@ describe('Priority state', function()
 
   local numeric_config = function()
     config:extend({
-      org_priority_highest = 10,
+      org_priority_highest = 1,
       org_priority_default = 5,
-      org_priority_lowest = 1,
+      org_priority_lowest = 15,
     })
   end
 
   it('should increase single numeric priority', function()
     numeric_config()
-    local priority = PriorityState:new(3)
-    assert.are.same('2', priority:increase())
+    local priority = PriorityState:new(10)
+    assert.are.same('9', priority:increase())
   end)
 
   it('should decrease single numeric priority', function()
     numeric_config()
-    local priority = PriorityState:new(3)
-    assert.are.same('4', priority:decrease())
+    local priority = PriorityState:new(9)
+    assert.are.same('10', priority:decrease())
   end)
 
   it('should increase single alpha priority', function()
@@ -44,13 +44,13 @@ describe('Priority state', function()
 
   it('should change to empty priority when numeric increased beyond highest', function()
     numeric_config()
-    local priority = PriorityState:new('10')
+    local priority = PriorityState:new('1')
     assert.are.same('', priority:increase())
   end)
 
   it('should change to empty priority when numeric decreased beyond lowest', function()
     numeric_config()
-    local priority = PriorityState:new('1')
+    local priority = PriorityState:new('15')
     assert.are.same('', priority:decrease())
   end)