refactor: closes #69, extract common functionality out of sources

Author: cseickel

doc/neo-tree.txt

@@ -465,23 +465,30 @@ require("neo-tree.events.queue").define_event(event_name, {
   setup = <function>,
   seed = <function>,
   teardown = <function>,
-  debounce_frequency = <number>
+  debounce_frequency = <number>,
+  once = <boolean>,
+  cancelled = <boolean>
 })
 
 The setup function is run the first time the event is subscribed to. For an
 autocmd event, this would define the vim autocmd to connect it to fire_event().
 
-The seed function is run at the begining of every event firing. The diagnostics
+The `seed` function is run at the begining of every event firing. The diagnostics
 event uses this to collect the diagnostic information and pass it to all
 subscribers.
 
-The teardown function is used when the last subscriber unsubscribes, and cleans
+The `teardown` function is used when the last subscriber unsubscribes, and cleans
 up. This is like Dispose in other languages.
 
-debounce_frequency is the minimum number of milliseconds between each invocation
+`debounce_frequenc`y is the minimum number of milliseconds between each invocation
 of the event. The first event is gauranteed to fire, as well as the last one, but
 in between events may be dropped if this is set to a number greater than zero.
 
+`once` means to only fire this event handler once then mark it as `cancelled`.
+
+`cancelled` means that this event handler will be skipped in all future event
+fires, and will be discarded on the next cleanup of the queue.
+
 
 ================================================================================
 OTHER SOURCES                                                                  ~

lua/neo-tree.lua

@@ -7,6 +7,7 @@ local events = require("neo-tree.events")
 local log = require("neo-tree.log")
 local popups = require("neo-tree.ui.popups")
 local highlights = require("neo-tree.ui.highlights")
+local manager = require("neo-tree.sources.manager")
 
 -- If you add a new source, you need to add it to the sources table.
 -- Each source should have a defaults module that contains the default values
@@ -19,7 +20,7 @@ local sources = {
 
 local M = {}
 
--- Adding this as a shortcut because the module path is so long.
+-- TODO: DEPRECATED in 1.19, remove in 2.0
 M.fs = require("neo-tree.sources.filesystem")
 
 local normalize_mappings = function(config)
@@ -68,80 +69,81 @@ local define_events = function()
   events_setup = true
 end
 
-local src = function(source_name)
+local check_source = function(source_name)
   if source_name == nil or source_name == "" then
     source_name = M.config.default_source
   end
-  local success, source = pcall(require, "neo-tree.sources." .. source_name)
+  local success, result = pcall(require, "neo-tree.sources." .. source_name)
   if not success then
-    error("Source " .. source_name .. " not found.")
+    error("Source " .. source_name .. " could not be loaded: ", result)
   end
-  source.name = source_name
-  return source
+  return source_name
 end
 
 M.close_all_except = function(source_name)
-  local source = src(source_name)
-  local target_pos = utils.get_value(M, "config." .. source.name .. ".window.position", "left")
+  source_name = check_source(source_name)
+  local target_pos = utils.get_value(M, "config." .. source_name .. ".window.position", "left")
   for _, name in ipairs(sources) do
     if name ~= source_name then
       local pos = utils.get_value(M, "config." .. name .. ".window.position", "left")
       if pos == target_pos then
-        M.close(name)
+        manager.close(source_name)
       end
     end
   end
-  M.close_all("float")
+  renderer.close_all_floating_windows()
 end
 
-M.close = function(source_name)
-  return src(source_name).close()
-end
+M.close = manager.close
 
 M.close_all = function(at_position)
   renderer.close_all_floating_windows()
   if type(at_position) == "string" and at_position > "" then
     for _, name in ipairs(sources) do
       local pos = utils.get_value(M, "config." .. name .. ".window.position", "left")
       if pos == at_position then
-        M.close(name)
+        manager.close(name)
       end
     end
   else
     for _, name in ipairs(sources) do
-      M.close(name)
+      manager.close(name)
     end
   end
 end
 
 M.float = function(source_name, toggle_if_open)
-  source_name = src(source_name).name
+  source_name = check_source(source_name)
   if toggle_if_open then
     if renderer.close_floating_window(source_name) then
       -- It was open, and now it's not.
       return
     end
   end
-  M.close_all("float")
-  M.close(source_name) -- in case this source is open in a sidebar
-  src(source_name).float()
+  renderer.close_all_floating_windows()
+  manager.close(source_name) -- in case this source is open in a sidebar
+  manager.float(source_name)
 end
 
 M.focus = function(source_name, close_others, toggle_if_open)
+  source_name = check_source(source_name)
   if toggle_if_open then
-    if M.close(source_name) then
+    if manager.close(source_name) then
       -- It was open, and now it's not.
       return
     end
   end
   if close_others == nil then
     close_others = true
   end
-  local source = src(source_name)
   if close_others then
-    M.close_all_except(source.name)
+    M.close_all_except(source_name)
   end
-  source.focus()
+  manager.focus(source_name)
+end
+
+M.reveal_current_file = function(source_name, toggle_if_open)
+  manager.reveal_current_file(source_name, toggle_if_open)
 end
 
 M.get_prior_window = function()
@@ -200,26 +202,26 @@ M.win_enter_event = function()
 end
 
 M.show = function(source_name, do_not_focus, close_others, toggle_if_open)
+  source_name = check_source(source_name)
   if toggle_if_open then
-    if M.close(source_name) then
+    if manager.close(source_name) then
       -- It was open, and now it's not.
       return
     end
   end
   if close_others == nil then
     close_others = true
   end
-  local source = src(source_name)
   if close_others then
-    M.close_all_except(source.name)
+    M.close_all_except(source_name)
   end
   if do_not_focus then
     local current_win = vim.api.nvim_get_current_win()
-    source.show(function()
+    manager.show(source_name, function()
       vim.api.nvim_set_current_win(current_win)
     end)
   else
-    source.show()
+    manager.show(source_name)
   end
 end
 
@@ -308,7 +310,7 @@ M.setup = function(config)
 
   -- setup the sources with the combined config
   for _, source_name in ipairs(sources) do
-    src(source_name).setup(M.config[source_name], M.config)
+    manager.setup(source_name, M.config[source_name], M.config)
   end
 
   local event_handler = {

lua/neo-tree/sources/buffers/commands.lua

@@ -4,41 +4,42 @@ local vim = vim
 local cc = require("neo-tree.sources.common.commands")
 local buffers = require("neo-tree.sources.buffers")
 local utils = require("neo-tree.utils")
+local manager = require("neo-tree.sources.manager")
 
 local M = {}
 
 M.add = function(state)
-  cc.add(state, buffers.refresh)
+  cc.add(state, M.refresh)
 end
 
 M.buffer_delete = function(state)
   local node = state.tree:get_node()
   if node then
     vim.api.nvim_buf_delete(node.extra.bufnr, { force = false, unload = false })
-    buffers.refresh()
+    M.refresh()
   end
 end
 M.close_node = cc.close_node
 
 ---Marks node as copied, so that it can be pasted somewhere else.
 M.copy_to_clipboard = function(state)
-  cc.copy_to_clipboard(state, buffers.redraw)
+  cc.copy_to_clipboard(state, utils.wrap(manager.redraw, "buffers"))
 end
 
 ---Marks node as cut, so that it can be pasted (moved) somewhere else.
 M.cut_to_clipboard = function(state)
-  cc.cut_to_clipboard(state, buffers.redraw)
+  cc.cut_to_clipboard(state, utils.wrap(manager.redraw, "buffers"))
 end
 
 M.show_debug_info = cc.show_debug_info
 
 ---Pastes all items from the clipboard to the current directory.
 M.paste_from_clipboard = function(state)
-  cc.paste_from_clipboard(state, buffers.refresh)
+  cc.paste_from_clipboard(state, M.refresh)
 end
 
 M.delete = function(state)
-  cc.delete(state, buffers.refresh)
+  cc.delete(state, M.refresh)
 end
 
 ---Navigate up one level.
@@ -51,10 +52,10 @@ M.open = cc.open
 M.open_split = cc.open_split
 M.open_vsplit = cc.open_vsplit
 
-M.refresh = buffers.refresh
+M.refresh = utils.wrap(manager.refresh, "buffers")
 
 M.rename = function(state)
-  cc.rename(state, buffers.refresh)
+  cc.rename(state, M.refresh)
 end
 
 M.set_root = function(state)