From 0033b26e38eef64569e8bb8b22f681c6b219a6df Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Tue, 10 Mar 2026 22:11:37 -0400 Subject: [PATCH] refactor(forge): extract ForgeBackend class and registry Problem: adding a new forge required touching 5 lookup tables (`FORGE_HOSTS`, `FORGE_CLI`, `FORGE_AUTH_CMD`, `SHORTHAND_PREFIX`, `_warned_forges`) and every branching site in `_api_args`, `fetch_metadata`, and `parse_ref`. Solution: introduce a `ForgeBackend` class with `parse_url`, `api_args`, and `parse_state` methods, plus a `register()` / `backends()` registry. New forges (Gitea, Forgejo) are a single `register()` call via the `gitea_backend()` convenience constructor. --- lua/pending/config.lua | 4 +- lua/pending/forge.lua | 473 ++++++++++++++++++++++++++--------------- lua/pending/health.lua | 14 +- spec/forge_spec.lua | 75 +++++++ 4 files changed, 380 insertions(+), 186 deletions(-) diff --git a/lua/pending/config.lua b/lua/pending/config.lua index c777fc9..b1ab639 100644 --- a/lua/pending/config.lua +++ b/lua/pending/config.lua @@ -41,9 +41,7 @@ ---@class pending.ForgeConfig ---@field auto_close? boolean ---@field warn_missing_cli? boolean ----@field github? pending.ForgeInstanceConfig ----@field gitlab? pending.ForgeInstanceConfig ----@field codeberg? pending.ForgeInstanceConfig +---@field [string] pending.ForgeInstanceConfig ---@class pending.SyncConfig ---@field remote_delete? boolean diff --git a/lua/pending/forge.lua b/lua/pending/forge.lua index 8318d26..6da8186 100644 --- a/lua/pending/forge.lua +++ b/lua/pending/forge.lua @@ -2,7 +2,7 @@ local config = require('pending.config') local log = require('pending.log') ---@class pending.ForgeRef ----@field forge 'github'|'gitlab'|'codeberg' +---@field forge string ---@field owner string ---@field repo string ---@field type 'issue'|'pull_request'|'merge_request' @@ -15,39 +15,66 @@ local log = require('pending.log') ---@field labels? string[] ---@field fetched_at string +---@class pending.ForgeBackend +---@field name string +---@field shorthand string +---@field default_host string +---@field cli string +---@field auth_cmd string +---@field default_icon string +---@field default_issue_format string +---@field _warned boolean +---@field parse_url fun(self: pending.ForgeBackend, url: string): pending.ForgeRef? +---@field api_args fun(self: pending.ForgeBackend, ref: pending.ForgeRef): string[] +---@field parse_state fun(self: pending.ForgeBackend, decoded: table): 'open'|'closed'|'merged' + ---@class pending.forge local M = {} ----@type table -local FORGE_HOSTS = { - ['github.com'] = 'github', - ['gitlab.com'] = 'gitlab', - ['codeberg.org'] = 'codeberg', -} +---@type pending.ForgeBackend[] +local _backends = {} ----@type table -local FORGE_CLI = { - github = 'gh', - gitlab = 'glab', - codeberg = 'tea', -} +---@type table +local _by_name = {} ----@type table -local FORGE_AUTH_CMD = { - github = 'gh auth login', - gitlab = 'glab auth login', - codeberg = 'tea login add', -} +---@type table +local _by_shorthand = {} ----@type table -local _warned_forges = {} +---@type table +local _by_host = {} ----@type table -local SHORTHAND_PREFIX = { - gh = 'github', - gl = 'gitlab', - cb = 'codeberg', -} +---@type boolean +local _instances_resolved = false + +---@param backend pending.ForgeBackend +---@return nil +function M.register(backend) + backend._warned = false + table.insert(_backends, backend) + _by_name[backend.name] = backend + _by_shorthand[backend.shorthand] = backend + _by_host[backend.default_host] = backend + _instances_resolved = false +end + +---@return pending.ForgeBackend[] +function M.backends() + return _backends +end + +local function _ensure_instances() + if _instances_resolved then + return + end + _instances_resolved = true + local cfg = config.get().forge or {} + for _, backend in ipairs(_backends) do + local forge_cfg = cfg[backend.name] or {} + for _, inst in ipairs(forge_cfg.instances or {}) do + _by_host[inst] = backend + end + end +end ---@param token string ---@return pending.ForgeRef? @@ -56,8 +83,8 @@ function M._parse_shorthand(token) if not prefix then return nil end - local forge = SHORTHAND_PREFIX[prefix] - if not forge then + local backend = _by_shorthand[prefix] + if not backend then return nil end local owner, repo, number = rest:match('^([%w%.%-_]+)/([%w%.%-_]+)#(%d+)$') @@ -65,12 +92,9 @@ function M._parse_shorthand(token) return nil end local num = tonumber(number) --[[@as integer]] - local host = forge == 'github' and 'github.com' - or forge == 'gitlab' and 'gitlab.com' - or 'codeberg.org' - local url = 'https://' .. host .. '/' .. owner .. '/' .. repo .. '/issues/' .. num + local url = 'https://' .. backend.default_host .. '/' .. owner .. '/' .. repo .. '/issues/' .. num return { - forge = forge, + forge = backend.name, owner = owner, repo = repo, type = 'issue', @@ -82,115 +106,31 @@ end ---@param url string ---@return pending.ForgeRef? function M._parse_github_url(url) - local host, owner, repo, kind, number = - url:match('^https?://([^/]+)/([%w%.%-_]+)/([%w%.%-_]+)/(%a+)/(%d+)$') - if not host then + local backend = _by_name['github'] + if not backend then return nil end - if kind ~= 'issues' and kind ~= 'pull' then - return nil - end - local forge_name = FORGE_HOSTS[host] - if not forge_name then - local cfg = config.get().forge or {} - local gh_cfg = cfg.github or {} - for _, inst in ipairs(gh_cfg.instances or {}) do - if host == inst then - forge_name = 'github' - break - end - end - end - if forge_name ~= 'github' then - return nil - end - local num = tonumber(number) --[[@as integer]] - local ref_type = kind == 'pull' and 'pull_request' or 'issue' - return { - forge = 'github', - owner = owner, - repo = repo, - type = ref_type, - number = num, - url = url, - } + return backend:parse_url(url) end ---@param url string ---@return pending.ForgeRef? function M._parse_gitlab_url(url) - local host, path, kind, number = url:match('^https?://([^/]+)/(.+)/%-/([%w_]+)/(%d+)$') - if not host then + local backend = _by_name['gitlab'] + if not backend then return nil end - if kind ~= 'issues' and kind ~= 'merge_requests' then - return nil - end - local forge_name = FORGE_HOSTS[host] - if not forge_name then - local cfg = config.get().forge or {} - local gl_cfg = cfg.gitlab or {} - for _, inst in ipairs(gl_cfg.instances or {}) do - if host == inst then - forge_name = 'gitlab' - break - end - end - end - if forge_name ~= 'gitlab' then - return nil - end - local owner, repo = path:match('^(.+)/([^/]+)$') - if not owner then - return nil - end - local num = tonumber(number) --[[@as integer]] - local ref_type = kind == 'merge_requests' and 'merge_request' or 'issue' - return { - forge = 'gitlab', - owner = owner, - repo = repo, - type = ref_type, - number = num, - url = url, - } + return backend:parse_url(url) end ---@param url string ---@return pending.ForgeRef? function M._parse_codeberg_url(url) - local host, owner, repo, kind, number = - url:match('^https?://([^/]+)/([%w%.%-_]+)/([%w%.%-_]+)/(%a+)/(%d+)$') - if not host then + local backend = _by_name['codeberg'] + if not backend then return nil end - if kind ~= 'issues' and kind ~= 'pulls' then - return nil - end - local forge_name = FORGE_HOSTS[host] - if not forge_name then - local cfg = config.get().forge or {} - local cb_cfg = cfg.codeberg or {} - for _, inst in ipairs(cb_cfg.instances or {}) do - if host == inst then - forge_name = 'codeberg' - break - end - end - end - if forge_name ~= 'codeberg' then - return nil - end - local num = tonumber(number) --[[@as integer]] - local ref_type = kind == 'pulls' and 'pull_request' or 'issue' - return { - forge = 'codeberg', - owner = owner, - repo = repo, - type = ref_type, - number = num, - url = url, - } + return backend:parse_url(url) end ---@param token string @@ -203,7 +143,16 @@ function M.parse_ref(token) if not token:match('^https?://') then return nil end - return M._parse_github_url(token) or M._parse_gitlab_url(token) or M._parse_codeberg_url(token) + _ensure_instances() + local host = token:match('^https?://([^/]+)') + if not host then + return nil + end + local backend = _by_host[host] + if not backend then + return nil + end + return backend:parse_url(token) end ---@class pending.ForgeSpan @@ -242,28 +191,11 @@ end ---@param ref pending.ForgeRef ---@return string[] function M._api_args(ref) - if ref.forge == 'github' then - return { - 'gh', - 'api', - '/repos/' .. ref.owner .. '/' .. ref.repo .. '/issues/' .. ref.number, - } - elseif ref.forge == 'gitlab' then - local encoded = (ref.owner .. '/' .. ref.repo):gsub('/', '%%2F') - local endpoint = ref.type == 'merge_request' and 'merge_requests' or 'issues' - return { - 'glab', - 'api', - '/projects/' .. encoded .. '/' .. endpoint .. '/' .. ref.number, - } - else - local endpoint = ref.type == 'pull_request' and 'pulls' or 'issues' - return { - 'tea', - 'api', - '/repos/' .. ref.owner .. '/' .. ref.repo .. '/' .. endpoint .. '/' .. ref.number, - } + local backend = _by_name[ref.forge] + if not backend then + return {} end + return backend:api_args(ref) end ---@param ref pending.ForgeRef @@ -273,8 +205,11 @@ end function M.format_label(ref, cache) local cfg = config.get().forge or {} local forge_cfg = cfg[ref.forge] or {} - local fmt = forge_cfg.issue_format or '%i %o/%r#%n' - local icon = forge_cfg.icon or '' + local backend = _by_name[ref.forge] + local default_icon = backend and backend.default_icon or '' + local default_fmt = backend and backend.default_issue_format or '%i %o/%r#%n' + local fmt = forge_cfg.issue_format or default_fmt + local icon = forge_cfg.icon or default_icon local text = fmt :gsub('%%i', icon) :gsub('%%o', ref.owner) @@ -298,11 +233,10 @@ function M.fetch_metadata(ref, callback) if result.code ~= 0 or not result.stdout or result.stdout == '' then vim.schedule(function() local forge_cfg = config.get().forge or {} - if forge_cfg.warn_missing_cli ~= false and not _warned_forges[ref.forge] then - _warned_forges[ref.forge] = true - local cli = FORGE_CLI[ref.forge] - local auth_cmd = FORGE_AUTH_CMD[ref.forge] - log.warn(('%s not found or not authenticated — run `%s`'):format(cli, auth_cmd)) + local backend = _by_name[ref.forge] + if backend and forge_cfg.warn_missing_cli ~= false and not backend._warned then + backend._warned = true + log.warn(('%s not found or not authenticated — run `%s`'):format(backend.cli, backend.auth_cmd)) end callback(nil) end) @@ -315,24 +249,8 @@ function M.fetch_metadata(ref, callback) end) return end - local state = 'open' - if ref.forge == 'github' then - if decoded.pull_request and decoded.pull_request.merged_at then - state = 'merged' - elseif decoded.state == 'closed' then - state = 'closed' - end - elseif ref.forge == 'gitlab' then - if decoded.state == 'merged' then - state = 'merged' - elseif decoded.state == 'closed' then - state = 'closed' - end - else - if decoded.state == 'closed' then - state = 'closed' - end - end + local backend = _by_name[ref.forge] + local state = backend and backend:parse_state(decoded) or 'open' local labels = {} if decoded.labels then for _, label in ipairs(decoded.labels) do @@ -408,4 +326,211 @@ function M.refresh(s) end end +---@param opts {name: string, shorthand: string, default_host: string, cli?: string, auth_cmd?: string, default_icon?: string, default_issue_format?: string} +---@return pending.ForgeBackend +function M.gitea_backend(opts) + return { + name = opts.name, + shorthand = opts.shorthand, + default_host = opts.default_host, + cli = opts.cli or 'tea', + auth_cmd = opts.auth_cmd or 'tea login add', + default_icon = opts.default_icon or '', + default_issue_format = opts.default_issue_format or '%i %o/%r#%n', + _warned = false, + parse_url = function(self, url) + _ensure_instances() + local host, owner, repo, kind, number = + url:match('^https?://([^/]+)/([%w%.%-_]+)/([%w%.%-_]+)/(%a+)/(%d+)$') + if not host then + return nil + end + if kind ~= 'issues' and kind ~= 'pulls' then + return nil + end + if _by_host[host] ~= self then + return nil + end + local num = tonumber(number) --[[@as integer]] + local ref_type = kind == 'pulls' and 'pull_request' or 'issue' + return { + forge = self.name, + owner = owner, + repo = repo, + type = ref_type, + number = num, + url = url, + } + end, + api_args = function(self, ref) + local endpoint = ref.type == 'pull_request' and 'pulls' or 'issues' + return { + self.cli, + 'api', + '/repos/' .. ref.owner .. '/' .. ref.repo .. '/' .. endpoint .. '/' .. ref.number, + } + end, + parse_state = function(_, decoded) + if decoded.state == 'closed' then + return 'closed' + end + return 'open' + end, + } +end + +M.register({ + name = 'github', + shorthand = 'gh', + default_host = 'github.com', + cli = 'gh', + auth_cmd = 'gh auth login', + default_icon = '', + default_issue_format = '%i %o/%r#%n', + _warned = false, + parse_url = function(self, url) + _ensure_instances() + local host, owner, repo, kind, number = + url:match('^https?://([^/]+)/([%w%.%-_]+)/([%w%.%-_]+)/(%a+)/(%d+)$') + if not host then + return nil + end + if kind ~= 'issues' and kind ~= 'pull' then + return nil + end + if _by_host[host] ~= self then + return nil + end + local num = tonumber(number) --[[@as integer]] + local ref_type = kind == 'pull' and 'pull_request' or 'issue' + return { + forge = 'github', + owner = owner, + repo = repo, + type = ref_type, + number = num, + url = url, + } + end, + api_args = function(_, ref) + return { + 'gh', + 'api', + '/repos/' .. ref.owner .. '/' .. ref.repo .. '/issues/' .. ref.number, + } + end, + parse_state = function(_, decoded) + if decoded.pull_request and decoded.pull_request.merged_at then + return 'merged' + elseif decoded.state == 'closed' then + return 'closed' + end + return 'open' + end, +}) + +M.register({ + name = 'gitlab', + shorthand = 'gl', + default_host = 'gitlab.com', + cli = 'glab', + auth_cmd = 'glab auth login', + default_icon = '', + default_issue_format = '%i %o/%r#%n', + _warned = false, + parse_url = function(self, url) + _ensure_instances() + local host, path, kind, number = url:match('^https?://([^/]+)/(.+)/%-/([%w_]+)/(%d+)$') + if not host then + return nil + end + if kind ~= 'issues' and kind ~= 'merge_requests' then + return nil + end + if _by_host[host] ~= self then + return nil + end + local owner, repo = path:match('^(.+)/([^/]+)$') + if not owner then + return nil + end + local num = tonumber(number) --[[@as integer]] + local ref_type = kind == 'merge_requests' and 'merge_request' or 'issue' + return { + forge = 'gitlab', + owner = owner, + repo = repo, + type = ref_type, + number = num, + url = url, + } + end, + api_args = function(_, ref) + local encoded = (ref.owner .. '/' .. ref.repo):gsub('/', '%%2F') + local endpoint = ref.type == 'merge_request' and 'merge_requests' or 'issues' + return { + 'glab', + 'api', + '/projects/' .. encoded .. '/' .. endpoint .. '/' .. ref.number, + } + end, + parse_state = function(_, decoded) + if decoded.state == 'merged' then + return 'merged' + elseif decoded.state == 'closed' then + return 'closed' + end + return 'open' + end, +}) + +M.register({ + name = 'codeberg', + shorthand = 'cb', + default_host = 'codeberg.org', + cli = 'tea', + auth_cmd = 'tea login add', + default_icon = '', + default_issue_format = '%i %o/%r#%n', + _warned = false, + parse_url = function(self, url) + _ensure_instances() + local host, owner, repo, kind, number = + url:match('^https?://([^/]+)/([%w%.%-_]+)/([%w%.%-_]+)/(%a+)/(%d+)$') + if not host then + return nil + end + if kind ~= 'issues' and kind ~= 'pulls' then + return nil + end + if _by_host[host] ~= self then + return nil + end + local num = tonumber(number) --[[@as integer]] + local ref_type = kind == 'pulls' and 'pull_request' or 'issue' + return { + forge = 'codeberg', + owner = owner, + repo = repo, + type = ref_type, + number = num, + url = url, + } + end, + api_args = function(_, ref) + local endpoint = ref.type == 'pull_request' and 'pulls' or 'issues' + return { + 'tea', + 'api', + '/repos/' .. ref.owner .. '/' .. ref.repo .. '/' .. endpoint .. '/' .. ref.number, + } + end, + parse_state = function(_, decoded) + if decoded.state == 'closed' then + return 'closed' + end + return 'open' + end, +}) + return M diff --git a/lua/pending/health.lua b/lua/pending/health.lua index 209d7db..457eb67 100644 --- a/lua/pending/health.lua +++ b/lua/pending/health.lua @@ -47,16 +47,12 @@ function M.check() end vim.health.start('pending.nvim: forge') - local forge_clis = { - { cmd = 'gh', name = 'GitHub', hint = 'gh auth login' }, - { cmd = 'glab', name = 'GitLab', hint = 'glab auth login' }, - { cmd = 'tea', name = 'Codeberg', hint = 'tea login add' }, - } - for _, cli in ipairs(forge_clis) do - if vim.fn.executable(cli.cmd) == 1 then - vim.health.ok(('%s found'):format(cli.cmd)) + local forge = require('pending.forge') + for _, backend in ipairs(forge.backends()) do + if vim.fn.executable(backend.cli) == 1 then + vim.health.ok(('%s found'):format(backend.cli)) else - vim.health.warn(('%s not found — run `%s`'):format(cli.cmd, cli.hint)) + vim.health.warn(('%s not found — run `%s`'):format(backend.cli, backend.auth_cmd)) end end diff --git a/spec/forge_spec.lua b/spec/forge_spec.lua index 3e7a677..fac8021 100644 --- a/spec/forge_spec.lua +++ b/spec/forge_spec.lua @@ -316,6 +316,81 @@ describe('forge parse.body integration', function() end) end) +describe('forge registry', function() + it('backends() returns all registered backends', function() + local backends = forge.backends() + assert.is_true(#backends >= 3) + local names = {} + for _, b in ipairs(backends) do + names[b.name] = true + end + assert.is_true(names['github']) + assert.is_true(names['gitlab']) + assert.is_true(names['codeberg']) + end) + + it('register() with custom backend resolves URLs', function() + local custom = forge.gitea_backend({ + name = 'mygitea', + shorthand = 'mg', + default_host = 'gitea.example.com', + }) + forge.register(custom) + + local ref = forge.parse_ref('https://gitea.example.com/alice/proj/issues/7') + assert.is_not_nil(ref) + assert.equals('mygitea', ref.forge) + assert.equals('alice', ref.owner) + assert.equals('proj', ref.repo) + assert.equals('issue', ref.type) + assert.equals(7, ref.number) + end) + + it('register() with custom shorthand resolves', function() + local ref = forge._parse_shorthand('mg:alice/proj#7') + assert.is_not_nil(ref) + assert.equals('mygitea', ref.forge) + assert.equals('alice', ref.owner) + assert.equals('proj', ref.repo) + assert.equals(7, ref.number) + end) + + it('_api_args dispatches to custom backend', function() + local args = forge._api_args({ + forge = 'mygitea', + owner = 'alice', + repo = 'proj', + type = 'issue', + number = 7, + url = '', + }) + assert.same({ 'tea', 'api', '/repos/alice/proj/issues/7' }, args) + end) + + it('gitea_backend() creates a working backend', function() + local b = forge.gitea_backend({ + name = 'forgejo', + shorthand = 'fj', + default_host = 'forgejo.example.com', + cli = 'forgejo-cli', + auth_cmd = 'forgejo-cli login', + }) + assert.equals('forgejo', b.name) + assert.equals('fj', b.shorthand) + assert.equals('forgejo-cli', b.cli) + + local ref = b:parse_url('https://forgejo.example.com/bob/repo/pulls/3') + assert.is_nil(ref) + + forge.register(b) + ref = b:parse_url('https://forgejo.example.com/bob/repo/pulls/3') + assert.is_not_nil(ref) + assert.equals('forgejo', ref.forge) + assert.equals('pull_request', ref.type) + assert.equals(3, ref.number) + end) +end) + describe('forge diff integration', function() local store = require('pending.store') local diff = require('pending.diff')