Merge pull request #1715 from lucasadelino/margin

Author: CKolkey

lua/neogit/buffers/status/actions.lua

@@ -454,6 +454,13 @@ M.v_log_popup = function(_self)
   return popups.open("log")
 end
 
+---@param self StatusBuffer
+M.v_margin_popup = function(self)
+  return popups.open("margin", function(p)
+    p { buffer = self }
+  end)
+end
+
 ---@param _self StatusBuffer
 M.v_worktree_popup = function(_self)
   return popups.open("worktree")
@@ -1418,6 +1425,7 @@ M.n_help_popup = function(self)
       bisect = { commits = commits },
       reset = { commit = commit },
       tag = { commit = commit },
+      margin = { buffer = self },
       stash = { name = stash and stash:match("^stash@{%d+}") },
       diff = {
         section = { name = section_name },
@@ -1456,6 +1464,13 @@ M.n_log_popup = function(_self)
   return popups.open("log")
 end
 
+---@param self StatusBuffer
+M.n_margin_popup = function(self)
+  return popups.open("margin", function(p)
+    p { buffer = self }
+  end)
+end
+
 ---@param _self StatusBuffer
 M.n_worktree_popup = function(_self)
   return popups.open("worktree")

lua/neogit/buffers/status/init.lua

@@ -127,6 +127,7 @@ function M:open(kind)
         [popups.mapping_for("HelpPopup")]       = self:_action("v_help_popup"),
         [popups.mapping_for("IgnorePopup")]     = self:_action("v_ignore_popup"),
         [popups.mapping_for("LogPopup")]        = self:_action("v_log_popup"),
+        [popups.mapping_for("MarginPopup")]     = self:_action("v_margin_popup"),
         [popups.mapping_for("MergePopup")]      = self:_action("v_merge_popup"),
         [popups.mapping_for("PullPopup")]       = self:_action("v_pull_popup"),
         [popups.mapping_for("PushPopup")]       = self:_action("v_push_popup"),
@@ -183,6 +184,7 @@ function M:open(kind)
         [popups.mapping_for("HelpPopup")]       = self:_action("n_help_popup"),
         [popups.mapping_for("IgnorePopup")]     = self:_action("n_ignore_popup"),
         [popups.mapping_for("LogPopup")]        = self:_action("n_log_popup"),
+        [popups.mapping_for("MarginPopup")]     = self:_action("n_margin_popup"),
         [popups.mapping_for("MergePopup")]      = self:_action("n_merge_popup"),
         [popups.mapping_for("PullPopup")]       = self:_action("n_pull_popup"),
         [popups.mapping_for("PushPopup")]       = self:_action("n_push_popup"),

lua/neogit/buffers/status/ui.lua

@@ -2,7 +2,9 @@ local Ui = require("neogit.lib.ui")
 local Component = require("neogit.lib.ui.component")
 local util = require("neogit.lib.util")
 local common = require("neogit.buffers.common")
+local config = require("neogit.config")
 local a = require("plenary.async")
+local state = require("neogit.lib.state")
 
 local col = Ui.col
 local row = Ui.row
@@ -323,7 +325,7 @@ local SectionItemCommit = Component.new(function(item)
   local ref = {}
   local ref_last = {}
 
-  if item.commit.ref_name ~= "" then
+  if item.commit.ref_name ~= "" and state.get({ "NeogitMarginPopup", "decorate" }, true) then
     -- Render local only branches first
     for name, _ in pairs(item.decoration.locals) do
       if name:match("^refs/") then
@@ -359,6 +361,79 @@ local SectionItemCommit = Component.new(function(item)
     end
   end
 
+  local virtual_text
+
+  -- Render author and date in margin, if visible
+  if state.get({ "margin", "visibility" }, false) then
+    local margin_date_style = state.get({ "margin", "date_style" }, 1)
+    local details = state.get({ "margin", "details" }, false)
+
+    local date
+    local rel_date
+    local date_width = 10
+    local clamp_width = 30 -- to avoid having too much space when relative date is short
+
+    -- Render date
+    if item.commit.rel_date:match(" years?,") then
+      rel_date, _ = item.commit.rel_date:gsub(" years?,", "y")
+      rel_date = rel_date .. " "
+    elseif item.commit.rel_date:match("^%d ") then
+      rel_date = " " .. item.commit.rel_date
+    else
+      rel_date = item.commit.rel_date
+    end
+
+    if margin_date_style == 1 then -- relative date (short)
+      local unpacked = vim.split(rel_date, " ")
+
+      -- above, we added a space if the rel_date started with a single number
+      -- we get the last two elements to deal with that
+      local date_number = unpacked[#unpacked - 1]
+      local date_quantifier = unpacked[#unpacked]
+      if date_quantifier:match("months?") then
+        date_quantifier = date_quantifier:gsub("m", "M") -- to distinguish from minutes
+      end
+
+      -- add back the space if we have a single number
+      local left_pad
+      if #unpacked > 2 then
+        left_pad = " "
+      else
+        left_pad = ""
+      end
+
+      date = left_pad .. date_number .. date_quantifier:sub(1, 1)
+      date_width = 3
+      clamp_width = 23
+    elseif margin_date_style == 2 then -- relative date (long)
+      date = rel_date
+      date_width = 10
+    else -- local iso date
+      if config.values.log_date_format == nil then
+        -- we get the unix date to be able to convert the date to the local timezone
+        date = os.date("%Y-%m-%d %H:%M", item.commit.unix_date)
+        date_width = 16 -- TODO: what should the width be here?
+      else
+        date = item.commit.log_date
+        date_width = 16
+      end
+    end
+
+    local author_table = { "" }
+    if details then
+      author_table = {
+        util.str_clamp(item.commit.author_name, clamp_width - (#date > date_width and #date or date_width)),
+        "NeogitGraphAuthor",
+      }
+    end
+
+    virtual_text = {
+      { " ", "Constant" },
+      author_table,
+      { util.str_min_width(date, date_width), "Special" },
+    }
+  end
+
   return row(
     util.merge(
       { text.highlight("NeogitObjectId")(item.commit.abbreviated_commit) },
@@ -367,7 +442,12 @@ local SectionItemCommit = Component.new(function(item)
       ref_last,
       { text(item.commit.subject) }
     ),
-    { oid = item.commit.oid, yankable = item.commit.oid, item = item }
+    {
+      virtual_text = virtual_text,
+      oid = item.commit.oid,
+      yankable = item.commit.oid,
+      item = item,
+    }
   )
 end)
 

lua/neogit/config.lua

@@ -245,6 +245,7 @@ end
 ---| "PushPopup"
 ---| "CommitPopup"
 ---| "LogPopup"
+---| "MarginPopup"
 ---| "RevertPopup"
 ---| "StashPopup"
 ---| "IgnorePopup"
@@ -626,6 +627,7 @@ function M.get_default_values()
         ["c"] = "CommitPopup",
         ["f"] = "FetchPopup",
         ["l"] = "LogPopup",
+        ["L"] = "MarginPopup",
         ["m"] = "MergePopup",
         ["p"] = "PullPopup",
         ["r"] = "RebasePopup",

lua/neogit/lib/git/log.lua

@@ -30,6 +30,7 @@ local commit_header_pat = "([| ]*)(%*?)([| ]*)commit (%w+)"
 ---@field verification_flag string?
 ---@field rel_date string
 ---@field log_date string
+---@field unix_date string
 
 ---Parses the provided list of lines into a CommitLogEntry
 ---@param raw string[]
@@ -340,6 +341,7 @@ local function format(show_signature)
     committer_date = "%cD",
     rel_date = "%cr",
     log_date = "%cd",
+    unix_date = "%ct",
   }
 
   if show_signature then

lua/neogit/lib/popup/builder.lua

@@ -80,6 +80,10 @@ local M = {}
 ---@field description string
 ---@field callback function
 ---@field heading string?
+---@field persist_popup boolean? set to true to prevent closing the popup when invoking
+
+---@class PopupActionOptions
+---@field persist_popup boolean Controls if the action should close the popup (false/nil) or keep it open (true)
 
 ---@class PopupSwitchOpts
 ---@field enabled? boolean Controls if the switch should default to 'on' state
@@ -440,8 +444,11 @@ end
 ---@param keys string|string[] Key or list of keys for the user to press that runs the action
 ---@param description string Description of action in UI
 ---@param callback? fun(popup: PopupData) Function that gets run in async context
+---@param opts? PopupActionOptions
 ---@return self
-function M:action(keys, description, callback)
+function M:action(keys, description, callback, opts)
+  opts = opts or {}
+
   if type(keys) == "string" then
     keys = { keys }
   end
@@ -459,6 +466,7 @@ function M:action(keys, description, callback)
     keys = keys,
     description = description,
     callback = callback,
+    persist_popup = opts.persist_popup or false,
   })
 
   return self
@@ -470,10 +478,11 @@ end
 ---@param keys string|string[] Key or list of keys for the user to press that runs the action
 ---@param description string Description of action in UI
 ---@param callback? fun(popup: PopupData) Function that gets run in async context
+---@param opts? PopupActionOptions
 ---@return self
-function M:action_if(cond, keys, description, callback)
+function M:action_if(cond, keys, description, callback, opts)
   if cond then
-    return self:action(keys, description, callback)
+    return self:action(keys, description, callback, opts)
   end
 
   return self

lua/neogit/lib/popup/init.lua

@@ -366,7 +366,11 @@ function M:mappings()
         for _, key in ipairs(action.keys) do
           mappings.n[key] = a.void(function()
             logger.debug(string.format("[POPUP]: Invoking action %q of %s", key, self.state.name))
-            self:close()
+            if not action.persist_popup then
+              logger.debug("[POPUP]: Closing popup")
+              self:close()
+            end
+
             action.callback(self)
             Watcher.instance():dispatch_refresh()
           end)

lua/neogit/popups/help/actions.lua

@@ -21,6 +21,12 @@ local function present(commands)
     end
 
     if type(keymap) == "table" and next(keymap) then
+      -- HACK: Remove "za" as listed keymap for toggle action.
+      table.sort(keymap)
+      if name == "Toggle" and keymap[2] == "za" then
+        table.remove(keymap, 2)
+      end
+
       return { { name = name, keys = keymap, cmp = table.concat(keymap):lower(), fn = fn } }
     else
       return { { name = name, keys = {}, cmp = "", fn = fn } }
@@ -75,6 +81,9 @@ M.popups = function(env)
     { "LogPopup", "Log", popups.open("log", function(p)
       p(env.log)
     end) },
+    { "MarginPopup", "Margin", popups.open("margin", function(p)
+      p(env.margin)
+    end) },
     {
       "CherryPickPopup",
       "Cherry Pick",

lua/neogit/popups/margin/actions.lua

@@ -0,0 +1,32 @@
+local M = {}
+
+local state = require("neogit.lib.state")
+local a = require("plenary.async")
+
+function M.refresh_buffer(buffer)
+  return a.void(function()
+    buffer:dispatch_refresh({ update_diffs = { "*:*" } }, "margin_refresh_buffer")
+  end)
+end
+
+function M.toggle_visibility()
+  local visibility = state.get({ "margin", "visibility" }, false)
+  local new_visibility = not visibility
+  state.set({ "margin", "visibility" }, new_visibility)
+end
+
+function M.cycle_date_style()
+  local styles = { "relative_short", "relative_long", "local_datetime" }
+  local current_index = state.get({ "margin", "date_style" }, #styles)
+  local next_index = (current_index % #styles) + 1 -- wrap around to the first style
+
+  state.set({ "margin", "date_style" }, next_index)
+end
+
+function M.toggle_details()
+  local details = state.get({ "margin", "details" }, false)
+  local new_details = not details
+  state.set({ "margin", "details" }, new_details)
+end
+
+return M

lua/neogit/popups/margin/init.lua

@@ -0,0 +1,56 @@
+local popup = require("neogit.lib.popup")
+-- local config = require("neogit.config")
+local actions = require("neogit.popups.margin.actions")
+
+local M = {}
+
+-- TODO: Implement various flags/switches
+
+function M.create(env)
+  local p = popup
+    .builder()
+    :name("NeogitMarginPopup")
+    -- :option("n", "max-count", "256", "Limit number of commits", { default = "256", key_prefix = "-" })
+    -- :switch("o", "topo", "Order commits by", {
+    --   cli_suffix = "-order",
+    --   options = {
+    --     { display = "", value = "" },
+    --     { display = "topo", value = "topo" },
+    --     { display = "author-date", value = "author-date" },
+    --     { display = "date", value = "date" },
+    --   },
+    -- })
+    -- :switch("g", "graph", "Show graph", {
+    --   enabled = true,
+    --   internal = true,
+    --   incompatible = { "reverse" },
+    --   dependent = { "color" },
+    -- })
+    -- :switch_if(
+    --   config.values.graph_style == "ascii" or config.values.graph_style == "kitty",
+    --   "c",
+    --   "color",
+    --   "Show graph in color",
+    --   { internal = true, incompatible = { "reverse" } }
+    -- )
+    :switch(
+      "d",
+      "decorate",
+      "Show refnames",
+      { enabled = true, internal = true }
+    )
+    :group_heading("Refresh")
+    :action_if(env.buffer, "g", "buffer", actions.refresh_buffer(env.buffer), { persist_popup = true })
+    :new_action_group("Margin")
+    :action("L", "toggle visibility", actions.toggle_visibility, { persist_popup = true })
+    :action("l", "cycle style", actions.cycle_date_style, { persist_popup = true })
+    :action("d", "toggle details", actions.toggle_details, { persist_popup = true })
+    :action("x", "toggle shortstat", actions.log_current, { persist_popup = true })
+    :build()
+
+  p:show()
+
+  return p
+end
+
+return M