feat: implementing filters

Author: wllfaria

lua/ledger/config.lua

@@ -3,6 +3,7 @@ local M = {}
 --- @class ledger.Tui
 --- @field enabled boolean
 --- @field sections table<string, ledger.TuiSection>
+--- @field open_in_tab boolean
 
 --- @class ledger.TuiFilter
 --- @field flag string
@@ -171,6 +172,7 @@ local function get_default_config()
     },
     tui = {
       enabled = true,
+      open_in_tab = true,
       sections = {
         ["Show Balance"] = {
           command = "ledger --strict -f main.ledger bal",

lua/ledger/tui/init.lua

@@ -15,13 +15,20 @@ LedgerTui.__index = LedgerTui
 local instance
 
 function LedgerTui:setup()
+  local config = require("ledger.config").get()
+
   if self.running then
     print("ledger.nvim already has the tui open")
     return
   end
 
   logger:info("initializing tui view")
   self.running = true
+
+  if config.tui.open_in_tab then
+    vim.cmd("tabnew")
+  end
+
   self.layout:setup_windows()
   self.layout:setup_aucmds()
   self.reports:populate_reports()
@@ -30,7 +37,12 @@ end
 
 function LedgerTui:shutdown()
   self.layout:restore_window_options()
-  print("shutting down")
+  self.layout:close_buffer(self.layout.reports_buf)
+  self.layout:close_buffer(self.layout.help_buf)
+  self.layout:close_buffer(self.layout.hint_buf)
+  self.layout:close_buffer(self.layout.output_buf)
+  self.layout:close_buffer(self.layout.filters_buf)
+  self.running = false
 end
 
 function LedgerTui:set_keymaps()

lua/ledger/tui/layout.lua

@@ -14,6 +14,7 @@ local HL_GROUPS = {
 --- @field previous_signcolumn "no" | "yes"
 --- @field output_buf integer
 --- @field filters_buf integer
+--- @field applied_filters_buf integer
 --- @field reports_buf integer
 --- @field hint_buf integer
 --- @field help_buf integer
@@ -50,21 +51,33 @@ function LedgerTuiLayout.set_buffer_options()
   vim.bo.swapfile = false
 end
 
+--- @param buffer integer
+function LedgerTuiLayout:close_buffer(buffer)
+  if buffer == nil then
+    return
+  end
+
+  if vim.api.nvim_buf_is_valid(buffer) then
+    vim.api.nvim_buf_delete(buffer, { force = true })
+  end
+end
+
 --- sets up all the windows for the tui layout, which consists
 --- of three buffers, one for the reports, one for the output
 --- and one for working with filters, which is supposed to look
 --- something like this:
 ---
 --- ┌───┬───────────┬───┐
---- │   │           │   │
---- │ R │     O     │ F │
---- │   │           │   │
+--- │   │           │ F │
+--- │ R │     O     ├───┤
+--- │   │           │ A │
 --- ├───┴───────────┴───┤
 --- │       HINT        │
 --- └───────────────────┘
 --- R: Reports pane
 --- O: Outputs pane
 --- F: Filters pane
+--- A: Applied Filters pane
 function LedgerTuiLayout:setup_windows()
   vim.cmd("split")
   local hint_buf = vim.api.nvim_create_buf(false, true)
@@ -92,6 +105,12 @@ function LedgerTuiLayout:setup_windows()
   local filter_width = math.ceil(vim.o.columns * 0.15)
 
   vim.cmd("vertical resize " .. filter_width)
+
+  local applied_filters_buf = vim.api.nvim_create_buf(false, true)
+  vim.api.nvim_set_current_buf(applied_filters_buf)
+  self.set_buffer_options()
+  self:set_window_options()
+  vim.cmd("horizontal resize " .. filter_width)
   vim.cmd("wincmd h")
   vim.cmd("wincmd h")
 
@@ -105,6 +124,7 @@ function LedgerTuiLayout:setup_windows()
   vim.defer_fn(function()
     vim.api.nvim_set_option_value("modifiable", false, { buf = output_buf })
     vim.api.nvim_set_option_value("modifiable", false, { buf = filters_buf })
+    vim.api.nvim_set_option_value("modifiable", false, { buf = applied_filters_buf })
     vim.api.nvim_set_option_value("modifiable", false, { buf = reports_buf })
   end, 100)
 
@@ -113,6 +133,7 @@ function LedgerTuiLayout:setup_windows()
   self.output_buf = output_buf
   self.filters_buf = filters_buf
   self.reports_buf = reports_buf
+  self.applied_filters_buf = applied_filters_buf
   self:setup_keymaps()
 end
 
@@ -373,6 +394,57 @@ local function open_filter_input_popup()
 
   vim.api.nvim_open_win(hint_buf, false, win_config(center_y + 3 + 1, center_x, 4, "Summary"))
   vim.api.nvim_open_win(input_buf, true, win_config(center_y, center_x, 1))
+
+  vim.api.nvim_create_autocmd({ "BufLeave" }, {
+    group = layout.augroup,
+    buffer = input_buf,
+    callback = function()
+      if vim.api.nvim_buf_is_valid(hint_buf) then
+        vim.api.nvim_buf_delete(hint_buf, { force = true })
+      end
+      if vim.api.nvim_buf_is_valid(input_buf) then
+        vim.api.nvim_buf_delete(input_buf, { force = true })
+      end
+    end,
+  })
+
+  vim.api.nvim_buf_set_option(input_buf, "buftype", "acwrite")
+  vim.api.nvim_buf_set_option(input_buf, "bufhidden", "wipe")
+  vim.api.nvim_buf_set_option(input_buf, "swapfile", false)
+  vim.api.nvim_buf_set_name(input_buf, "InputBuffer")
+
+  vim.api.nvim_create_autocmd({ "BufWriteCmd" }, {
+    buffer = input_buf,
+    callback = function()
+      local lines = vim.api.nvim_buf_get_lines(input_buf, 0, -1, false)
+
+      if #lines > 0 then
+        local reports = require("ledger.tui.reports").get()
+        local layout = require("ledger.tui.layout").get()
+
+        local input = lines[1]
+        if reports.filters[report_name] == nil then
+          reports.filters[report_name] = { active = {} }
+        end
+        reports.filters[report_name].active[filter_name] = {
+          flag = filter.flag,
+          value = input,
+        }
+        logger:info("applying filter '" .. filter_name .. "' with input '" .. input .. "'")
+        layout.focus_reports()
+        reports:maybe_run_command()
+        reports:populate_filters()
+        layout:update_hint()
+      end
+
+      if vim.api.nvim_buf_is_valid(input_buf) then
+        vim.api.nvim_buf_delete(input_buf, { force = true })
+      end
+      if vim.api.nvim_buf_is_valid(hint_buf) then
+        vim.api.nvim_buf_delete(hint_buf, { force = true })
+      end
+    end,
+  })
 end
 
 local function dismiss_hint()
@@ -382,8 +454,10 @@ local function dismiss_hint()
     vim.api.nvim_set_current_buf(layout.reports_buf)
   end
 
-  vim.api.nvim_buf_delete(layout.hint_buf, {})
-  layout.hint_buf = -1
+  if vim.api.nvim_buf_is_valid(layout.hint_buf) then
+    vim.api.nvim_buf_delete(layout.hint_buf, {})
+    layout.hint_buf = -1
+  end
 end
 
 local function focus_reports()
@@ -406,6 +480,10 @@ local function focus_reports()
   end
 end
 
+function LedgerTuiLayout:focus_reports()
+  focus_reports()
+end
+
 local function focus_filters()
   local layout = require("ledger.tui.layout").get()
 
@@ -445,6 +523,7 @@ function LedgerTuiLayout:setup_keymaps()
   set_buffer_maps(self.output_buf)
   set_buffer_maps(self.filters_buf)
   set_buffer_maps(self.hint_buf)
+  -- set_buffer_maps(self.applied_filters_buf)
 
   vim.api.nvim_buf_create_user_command(self.filters_buf, "OpenFilterInput", open_filter_input_popup, {})
   vim.api.nvim_buf_set_keymap(self.filters_buf, "n", "<CR>", ":OpenFilterInput<CR>", {})

lua/ledger/tui/reports.lua

@@ -3,8 +3,16 @@ local logger = require("ledger.logger").get()
 
 local M = {}
 
+--- @class ledger.TuiReportEntryFilter
+--- @field flag string
+--- @field value string
+
+--- @class ledger.TuiReportEntry
+--- @field active table<string, ledger.TuiReportEntryFilter>
+
 --- @class ledger.TuiReports
 --- @field layout ledger.TuiLayout
+--- @field filters table<string, ledger.TuiReportEntry>
 local LedgerReports = {}
 LedgerReports.__index = LedgerReports
 
@@ -30,6 +38,17 @@ function LedgerReports:populate_filters()
       return
     end
   end
+
+  if self.filters[current_report] ~= nil then
+    local filters = {}
+
+    for name, filter in pairs(self.filters[current_report].active) do
+      local formatted = name .. " (" .. filter.flag .. ") " .. filter.value
+      table.insert(filters, formatted)
+    end
+
+    -- self.layout.set_buffer_content(self.layout.applied_filters_buf, filters)
+  end
 end
 
 function LedgerReports:populate_reports()
@@ -63,6 +82,21 @@ function LedgerReports:maybe_get_current_report()
   return true, row_content[1]
 end
 
+--- @param name string
+--- @param command ledger.TuiSection
+--- @return string
+function LedgerReports:apply_filters(name, command)
+  local command_string = command.command
+
+  if self.filters[name] then
+    for _, filter in pairs(self.filters[name].active) do
+      command_string = command_string .. " " .. filter.flag .. " " .. filter.value
+    end
+  end
+
+  return command_string
+end
+
 function LedgerReports:maybe_run_command()
   local ok, current_report = self:maybe_get_current_report()
   if not ok then
@@ -72,9 +106,11 @@ function LedgerReports:maybe_run_command()
   for name, command in pairs(config.tui.sections) do
     if name == current_report then
       local cwd = require("ledger.files").cwd()
-      logger:info('running command "' .. command.command)
 
-      local ok, pid = pcall(vim.system, vim.split(command.command, " "), { cwd = cwd })
+      local command = self:apply_filters(name, command)
+      logger:info('running command "' .. command)
+
+      local ok, pid = pcall(vim.system, vim.split(command, " "), { cwd = cwd })
       if not ok then
         logger:error("failed to run command")
         error("failed to run command")
@@ -89,7 +125,6 @@ function LedgerReports:maybe_run_command()
 
       local output_splitted = vim.split(output, "\n")
       self.layout.set_buffer_content(self.layout.output_buf, output_splitted)
-
       return
     end
   end
@@ -101,6 +136,7 @@ function M.setup(layout)
   if not instance then
     instance = setmetatable({
       layout = layout,
+      filters = {},
     }, LedgerReports)
   end
   return instance