Add work-around for plenary path bug on Windows (#349)

See nvim-lua/plenary.nvim#489

Author: epwalsh

CHANGELOG.md

@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 - Fixed a YAML parsing issue with unquoted URLs in an array item.
+- Fixed an issue on Windows when cloning a template into a new note. The root cause was this bug in plenary: https://github.com/nvim-lua/plenary.nvim/issues/489. We've added a work-around.
 
 ## [v2.7.1](https://github.com/epwalsh/obsidian.nvim/releases/tag/v2.7.1) - 2024-01-23
 

lua/obsidian/client.lua

@@ -966,7 +966,7 @@ Client._daily = function(self, datetime)
   if not note:exists() then
     local write_frontmatter = true
     if self.opts.daily_notes.template then
-      templates.clone_template(self.opts.daily_notes.template, tostring(path), self, note:display_name())
+      templates.clone_template(self.opts.daily_notes.template, path, self, note:display_name())
       note = Note.from_file(path, self.dir)
       if note.has_frontmatter then
         write_frontmatter = false

lua/obsidian/img_paste.lua

@@ -125,7 +125,7 @@ M.paste_img = function(fname, default_dir)
     end
 
     -- Ensure parent directory exists.
-    path:parent():mkdir { exists_ok = true, parents = true }
+    util.parent_directory(path):mkdir { exists_ok = true, parents = true }
 
     -- Paste image.
     local result = save_clipboard_image(tostring(path))

lua/obsidian/templates.lua

@@ -52,7 +52,7 @@ end
 ---Clone Template
 ---
 ---@param template_name string  - name of a template in the configured templates folder
----@param note_path string
+---@param note_path Path
 ---@param client obsidian.Client
 ---@param title string
 M.clone_template = function(template_name, note_path, client, title)
@@ -61,19 +61,24 @@ M.clone_template = function(template_name, note_path, client, title)
     log.err "Templates folder is not defined or does not exist"
     return
   end
+
+  util.parent_directory(note_path):mkdir { parents = true }
+
   local template_path = Path:new(templates_dir) / template_name
-  Path:new(note_path):parent():mkdir { parents = true }
   local template_file = io.open(tostring(template_path), "r")
-  local note_file = io.open(tostring(note_path), "wb")
   if not template_file then
-    return error("Unable to read template at " .. template_path)
+    return log.error("Unable to read template at '%s'", template_path)
   end
+
+  local note_file = io.open(tostring(note_path), "wb")
   if not note_file then
-    return error("Unable to write note at " .. note_path)
+    return log.error("Unable to write note at '%s'", note_path)
   end
+
   for line in template_file:lines "L" do
     note_file:write(M.substitute_template_variables(line, client, title))
   end
+
   template_file:close()
   note_file:close()
 end

lua/obsidian/util.lua

@@ -1,3 +1,4 @@
+local Path = require "plenary.path"
 local iter = require("obsidian.itertools").iter
 local log = require "obsidian.log"
 
@@ -371,6 +372,27 @@ util.string_replace = function(s, what, with, n)
   return s, count
 end
 
+------------------
+-- Path helpers --
+------------------
+
+--- Get the parent directory of a path.
+---
+---@param path string|Path
+---
+---@return Path
+util.parent_directory = function(path)
+  -- 'Path:parent()' has bugs on Windows, so we try 'vim.fs.dirname' first instead.
+  if vim.fs and vim.fs.dirname then
+    local dirname = vim.fs.dirname(tostring(path))
+    if dirname ~= nil then
+      return Path:new(dirname)
+    end
+  end
+
+  return Path:new(path):parent()
+end
+
 ------------------------------------
 -- Miscellaneous helper functions --
 ------------------------------------