refactor!: replace plenary.path with pathlib

Author: jghauser

lua/papis/completion/source.lua

@@ -5,7 +5,7 @@
 -- The cmp source.
 --
 
-local Path = require("plenary.path")
+local Path = require("pathlib")
 local ts = vim.treesitter
 local api = vim.api
 
@@ -51,9 +51,8 @@ end
 ---@return boolean #True if info_name file, false otherwise
 function M:is_available()
   local is_available = false
-  local current_filepath = Path:new((api.nvim_buf_get_name(0)))
-  local split_path = current_filepath:_split()
-  local filename = current_filepath:_split()[#split_path]
+  local current_filepath = Path(api.nvim_buf_get_name(0))
+  local filename = current_filepath:basename()
 
   local info_name = db.config:get_value({ id = 1 }, "info_name")
   if filename == info_name then

lua/papis/fs-watcher.lua

@@ -7,8 +7,7 @@
 -- Adapted from: https://github.com/rktjmp/fwatch.nvim
 --
 
-local Path = require("plenary.path")
-local Scan = require("plenary.scandir")
+local Path = require("pathlib")
 
 local uv = vim.loop
 local fs_stat = uv.fs_stat
@@ -45,15 +44,18 @@ local function do_watch(path, on_event, on_error)
       on_event(filename, unwatch_cb)
     end
   end
-  uv.fs_event_start(handle, path, {}, event_cb)
+  uv.fs_event_start(handle, tostring(path), {}, event_cb)
   table.insert(handles, handle)
 end
 
 ---Gets all directories in the library_dir
 ---@return table #A list of all directories in library_dir
 local function get_library_dirs()
-  local library_dir = Path:new(db.config:get_value({ id = 1 }, "dir")):expand()
-  local library_dirs = Scan.scan_dir(library_dir, { depth = 1, only_dirs = true })
+  local library_dir = Path(db.config:get_value({ id = 1 }, "dir"))
+  local library_dirs = {}
+  for path in library_dir:fs_iterdir() do
+    table.insert(library_dirs, path)
+  end
   return library_dirs
 end
 
@@ -75,7 +77,7 @@ local function init_fs_watcher(dir_to_watch, is_library_root)
     local do_update = true
     if is_library_root then
       log.debug("Filesystem event in the library root directory")
-      entry_dir = Path:new(dir_to_watch, filename)
+      entry_dir = Path(dir_to_watch, filename)
       info_path = entry_dir:joinpath(info_name)
       if entry_dir:exists() and entry_dir:is_dir() then
         log.debug(string.format("Filesystem event: path '%s' added", entry_dir:absolute()))
@@ -93,7 +95,7 @@ local function init_fs_watcher(dir_to_watch, is_library_root)
       end
     else
       log.debug("Filesystem event in entry directory")
-      entry_dir = Path:new(dir_to_watch)
+      entry_dir = Path(dir_to_watch)
       info_path = entry_dir:joinpath(info_name)
       if info_path:exists() then
         -- info file exists, update with new info
@@ -151,7 +153,7 @@ end
 ---Starts file system watchers for root dir and all entry dirs
 local function start_fs_watchers()
   log.debug("Set db state to indicate fswatcher is active")
-  local library_dir = Path:new(db.config:get_value({ id = 1 }, "dir")):expand()
+  local library_dir = Path(db.config:get_value({ id = 1 }, "dir"))
   db.state:set_fw_running(uv.os_getpid())
 
   log.debug("Setting up fswatcher for library root directory")

lua/papis/health.lua

@@ -5,7 +5,7 @@
 -- Implements checkhealth funtionality.
 --
 
-local Path = require("plenary.path")
+local Path = require("pathlib")
 
 local uv = vim.loop
 
@@ -22,7 +22,7 @@ local reports = {}
 ---Creates a report for the sqlite database
 reports["sqlite-wrapper"] = function()
   local sqlite_is_executable = vim.fn.executable("sqlite3")
-  local db_exists = Path:new(config["db_path"]):exists()
+  local db_exists = Path(config["db_path"]):exists()
   local db_is_empty = db.data:empty()
 
   health.start("Sqlite database")

lua/papis/papis-storage.lua

@@ -5,8 +5,7 @@
 -- Reads out all the Papis yaml files and creates data ready for db
 --
 
-local Path = require("plenary.path")
-local Scan = require("plenary.scandir")
+local Path = require("pathlib")
 
 local fs_stat = vim.loop.fs_stat
 
@@ -85,8 +84,8 @@ end
 local function read_yaml(path)
   log.trace("Reading path: " .. path)
   local entry
-  local filepath = Path:new(path)
-  local handler = io.popen(yq_bin .. ' -oj "' .. filepath:absolute() .. '" 2>/dev/null')
+  local filepath = Path(path)
+  local handler = io.popen(yq_bin .. ' -oj "' .. tostring(filepath) .. '" 2>/dev/null')
   if handler then
     local as_json = handler:read("*all")
     handler:close()
@@ -124,7 +123,7 @@ local function make_full_paths(filenames, path)
 
   local full_paths = {}
   for _, filename in ipairs(filenames) do
-    local full_path = Path:new(path, filename):expand()
+    local full_path = tostring(Path(path, filename))
     table.insert(full_paths, full_path)
   end
   return full_paths
@@ -142,15 +141,20 @@ end
 ---@param paths? table #A list with paths of papis entries
 ---@return table #A list of { path = path, mtime = mtime } values
 function M.get_metadata(paths)
-  local library_dir = Path:new(db.config:get_value({ id = 1 }, "dir"))
+  local library_dir = Path(db.config:get_value({ id = 1 }, "dir"))
   local info_name = db.config:get_value({ id = 1 }, "info_name")
-  paths = paths or Scan.scan_dir(library_dir:expand(), { depth = 2, search_pattern = info_name })
+  if not paths then
+    paths = {}
+    for path in library_dir:fs_iterdir() do
+      if path:basename() == info_name then
+        table.insert(paths, path)
+      end
+    end
+  end
   local metadata = {}
   for _, path in ipairs(paths) do
-    local mtime = fs_stat(path).mtime.sec
-    -- path = Path:new(path)
-    -- path = path:parent():absolute()
-    table.insert(metadata, { path = path, mtime = mtime })
+    local mtime = fs_stat(tostring(path)).mtime.sec
+    table.insert(metadata, { path = tostring(path), mtime = mtime })
   end
   return metadata
 end
@@ -183,7 +187,7 @@ function M.get_data_full(metadata)
             entry[key] = ensure_tags_are_tbl(entry[key])
           end
           if (key == "files") or (key == "notes") then
-            local entry_path = Path:new(path):parent()
+            local entry_path = Path(path):parent()
             entry[key] = make_full_paths(entry[key], entry_path)
           end
 

lua/papis/sqlite-wrapper.lua

@@ -15,9 +15,9 @@ end
 
 local sqlite = require("sqlite.db") --- for constructing sql databases
 
-local Path = require("plenary.path")
+local Path = require("pathlib")
 local config = require("papis.config")
-local db_uri = Path:new(config["db_path"])
+local db_uri = Path(config["db_path"])
 local data_tbl_schema = config["data_tbl_schema"]
 
 if not db_uri:exists() then
@@ -72,7 +72,7 @@ function tbl_methods.update(tbl, where, new_values)
 end
 
 local M = sqlite({
-  uri = db_uri:absolute(),
+  uri = tostring(db_uri),
   opts = { busy_timeout = 30000 },
 })
 

lua/papis/utils.lua

@@ -8,9 +8,9 @@
 local NuiLine = require("nui.line")
 local NuiPopup = require("nui.popup")
 local nuiEvent = require("nui.utils.autocmd").event
-local Path = require("plenary.path")
 local strdisplaywidth = require("plenary.strings").strdisplaywidth
 local job = require("plenary.job")
+local Path = require("pathlib")
 
 local new_timer = vim.loop.new_timer
 local os_name = vim.loop.os_uname()
@@ -90,8 +90,7 @@ function M.get_filenames(full_paths)
   local filenames = {}
   if full_paths then
     for _, full_path in ipairs(full_paths) do
-      local filename = Path:new(full_path):_split()
-      filename = filename[#filename]
+      local filename = Path(full_path):basename()
       table.insert(filenames, filename)
     end
   end
@@ -141,7 +140,7 @@ function M:do_open_text_file(papis_id, type)
   end
   log.debug("Opening a text file")
   local entry = db.data:get({ papis_id = papis_id }, { "notes", "id" })[1]
-  local info_path = Path:new(db.metadata:get_value({ entry = entry["id"] }, "path"))
+  local info_path = Path(db.metadata:get_value({ entry = entry["id"] }, "path"))
   log.debug("Text file in folder: " .. info_path:absolute())
   local cmd = ""
   if type == "note" then