rename

Author: jamestrew

lua/plenary/path2.lua

@@ -48,6 +48,8 @@
 ---   `C:/Users/test/test_file` relative to `C:/Windows/temp` is
 ---   `../../Users/test/test_file` and there's no home directory absolute path
 ---   in this.
+---
+--- - rename returns new path rather than mutating path
 
 local bit = require "plenary.bit"
 local uv = vim.loop
@@ -346,6 +348,7 @@ end
 ---@field relparts string[] path separator separated relative path parts
 ---@field sep string path separator (respects 'shellslash' on Windows)
 ---@field filename string
+---@field name string the final path component (eg. "foo/bar/baz.lua" -> "baz.lua")
 ---@field cwd string
 ---@field private _absolute string? lazy eval'ed fully resolved absolute path
 local Path = { path = path }
@@ -363,6 +366,15 @@ Path.__index = function(t, k)
     return rawget(t, k)
   end
 
+  if k == "name" then
+    if #t.relparts > 0 then
+      t.name = t.relparts[#t.relparts]
+    else
+      t.name = ""
+    end
+    return t.name
+  end
+
   if k == "anchor" then
     t.anchor = t.drv .. t.root
     return t.anchor
@@ -901,15 +913,13 @@ function Path:rm(opts)
 
   for p, dirs, files in self:walk(false) do
     for _, file in ipairs(files) do
-      print("delete file", file, (p / file):absolute())
       local _, err = uv.fs_unlink((p / file):absolute())
       if err then
         error(err)
       end
     end
 
     for _, dir in ipairs(dirs) do
-      print("delete dir", dir, (p / dir):absolute())
       local _, err = uv.fs_rmdir((p / dir):absolute())
       if err then
         error(err)
@@ -920,6 +930,29 @@ function Path:rm(opts)
   self:rmdir()
 end
 
+---@class plenary.Path2.renameOpts
+---@field new_name string|plenary.Path2 destination path
+
+---@param opts plenary.Path2.renameOpts
+---@return plenary.Path2
+function Path:rename(opts)
+  if not opts.new_name or opts.new_name == "" then
+    error "Please provide the new name!"
+  end
+
+  local new_path = self:parent() / opts.new_name ---@type plenary.Path2
+
+  if new_path:exists() then
+    error "File or directory already exists!"
+  end
+
+  local _, err = uv.fs_rename(self:absolute(), new_path:absolute())
+  if err ~= nil then
+    error(err)
+  end
+  return new_path
+end
+
 --- read file synchronously or asynchronously
 ---@param callback fun(data: string)? callback to use for async version, nil for default
 ---@return string? data

tests/plenary/path2_spec.lua

@@ -546,6 +546,95 @@ describe("Path2", function()
     end)
   end)
 
+  describe("rename", function()
+    after_each(function()
+      uv.fs_unlink "a_random_filename.lua"
+      uv.fs_unlink "not_a_random_filename.lua"
+      uv.fs_unlink "some_random_filename.lua"
+      uv.fs_unlink "../some_random_filename.lua"
+    end)
+
+    it_cross_plat("can rename a file", function()
+      local p = Path:new "a_random_filename.lua"
+      assert.no_error(function()
+        p:touch()
+      end)
+      assert.is_true(p:exists())
+
+      local new_p
+      assert.no_error(function()
+        new_p = p:rename { new_name = "not_a_random_filename.lua" }
+      end)
+      assert.not_nil(new_p)
+      assert.are.same("not_a_random_filename.lua", new_p.name)
+    end)
+
+    it_cross_plat("can handle an invalid filename", function()
+      local p = Path:new "some_random_filename.lua"
+      assert.no_error(function()
+        p:touch()
+      end)
+      assert.is_true(p:exists())
+
+      assert.has_error(function()
+        p:rename { new_name = "" }
+      end)
+      assert.has_error(function()
+        ---@diagnostic disable-next-line: missing-fields
+        p:rename {}
+      end)
+
+      assert.are.same("some_random_filename.lua", p.name)
+    end)
+
+    it_cross_plat("can move to parent dir", function()
+      local p = Path:new "some_random_filename.lua"
+      assert.no_error(function()
+        p:touch()
+      end)
+      assert.is_true(p:exists())
+
+      local new_p
+      assert.no_error(function()
+        new_p = p:rename { new_name = "../some_random_filename.lua" }
+      end)
+      assert.not_nil(new_p)
+      assert.are.same(Path:new("../some_random_filename.lua"):absolute(), new_p:absolute())
+    end)
+
+    it_cross_plat("cannot rename to an existing filename", function()
+      local p1 = Path:new "a_random_filename.lua"
+      local p2 = Path:new "not_a_random_filename.lua"
+      assert.no_error(function()
+        p1:touch()
+        p2:touch()
+      end)
+      assert.is_true(p1:exists())
+      assert.is_true(p2:exists())
+
+      assert.has_error(function()
+        p1:rename { new_name = "not_a_random_filename.lua" }
+      end)
+      assert.are.same(p1.filename, "a_random_filename.lua")
+    end)
+
+    it_cross_plat("handles Path as new_name", function()
+      local p1 = Path:new "a_random_filename.lua"
+      local p2 = Path:new "not_a_random_filename.lua"
+      assert.no_error(function()
+        p1:touch()
+      end)
+      assert.is_true(p1:exists())
+
+      local new_p
+      assert.no_error(function()
+        new_p = p1:rename { new_name = p2 }
+      end)
+      assert.not_nil(new_p)
+      assert.are.same("not_a_random_filename.lua", new_p.name)
+    end)
+  end)
+
   describe("parents", function()
     it_cross_plat("should extract the ancestors of the path", function()
       local p = Path:new(vim.fn.getcwd())