exist and is_file

Author: jamestrew

lua/plenary/path2.lua

@@ -1,3 +1,25 @@
+--- NOTES:
+--- Rework on plenary.Path with a focus on better cross-platform support
+--- including 'shellslash' support.
+--- Effort to improve performance made (notably `:absolue` ~2x faster).
+---
+--- Some finiky behaviors ironed out
+--- eg. `:normalize`
+--- TODO: demonstrate
+---
+--- BREAKING CHANGES:
+--- - `Path.new` no longer supported (think it's more confusing that helpful
+---   and not really used as far as I can tell)
+---
+--- - drop `__concat` metamethod? it was untested, not sure how functional it is
+---
+--- - `Path` objects are now "read-only", I don't think people were ever doing
+---   things like `path.filename = 'foo'` but now explicitly adding some barrier
+---   to this. Allows us to compute `filename` from "metadata" parsed once on
+---   instantiation.
+
+--- TODO: rework `split_root` logic according to python 3.12
+
 local uv = vim.loop
 local iswin = uv.os_uname().sysname == "Windows_NT"
 local hasshellslash = vim.fn.exists "+shellslash" == 1
@@ -264,19 +286,32 @@ Path.__index = function(t, k)
   end
 end
 
+---@param self plenary.Path2
+---@param other string|plenary.Path2
+---@return plenary.Path2
 Path.__div = function(self, other)
   assert(Path.is_path(self))
   assert(Path.is_path(other) or type(other) == "string")
 
   return self:joinpath(other)
 end
 
+---@param self plenary.Path2
+---@return string
 Path.__tostring = function(self)
   return self.filename
 end
 
-Path.__concat = function(self, other)
-  return self.filename .. other
+---@param self plenary.Path2
+---@param other string|plenary.Path2
+---@return boolean
+Path.__eq = function(self, other)
+  assert(Path.is_path(self))
+  assert(Path.is_path(other) or type(other) == "string")
+  -- TODO
+  if true then
+    error "not yet implemented"
+  end
 end
 
 ---@alias plenary.Path2Args string|plenary.Path2|(string|plenary.Path2)[]
@@ -335,6 +370,7 @@ function Path:new(...)
     __div = function(t, other) return Path.__div(t, other) end,
     __concat = function(t, other) return Path.__concat(t, other) end,
     __tostring = function(t) return Path.__tostring(t) end,
+    __eq = function(t, other) return Path.__eq(t, other) end,
     __metatable = Path,
     -- stylua: ignore end
   })
@@ -379,6 +415,12 @@ function Path:is_absolute()
   return self._path.has_drv and self.drv ~= ""
 end
 
+---@return boolean
+function Path:exists()
+  local stat = uv.fs_stat(self:absolute())
+  return stat ~= nil and not vim.tbl_isempty(stat)
+end
+
 --- if path doesn't exists, returns false
 ---@return boolean
 function Path:is_dir()
@@ -389,6 +431,16 @@ function Path:is_dir()
   return false
 end
 
+--- if path doesn't exists, returns false
+---@return boolean
+function Path:is_file()
+  local stat = uv.fs_stat(self:absolute())
+  if stat then
+    return stat.type == "file"
+  end
+  return false
+end
+
 ---@param parts string[] path parts
 ---@return string[]
 local function resolve_dots(parts)
@@ -443,8 +495,46 @@ function Path:joinpath(...)
   return Path:new { self, ... }
 end
 
+--- makes a path relative to another (by default the cwd).
+--- if path is already a relative path
+---@param to string|plenary.Path2? absolute path to make relative to (default: cwd)
+---@return string
+function Path:make_relative(to)
+  to = vim.F.if_nil(to, self.cwd)
+  if type(to) == "string" then
+    to = Path:new(to)
+  end
+
+  if self:is_absolute() then
+    local to_abs = to:absolute()
+
+    if to_abs == self:absolute() then
+      return "."
+    else
+      -- TODO
+    end
+  else
+  end
+
+  -- SEE: `Path.relative_to` implementation (3.12) specifically `walk_up` param
+
+  local matches = true
+  for i = 1, #to.parts do
+    if to.parts[i] ~= self.parts[i] then
+      matches = false
+      break
+    end
+  end
+
+  if matches then
+    return "."
+  end
+
+  -- /home/jt/foo/bar/baz
+  -- /home/jt
+end
+
 -- vim.o.shellslash = false
-local p = Path:new("lua"):joinpath "plenary"
 -- vim.print(p)
 -- print(p.filename, p:is_absolute(), p:absolute())
 -- vim.o.shellslash = true

tests/plenary/path2_spec.lua

@@ -229,6 +229,16 @@ describe("Path2", function()
     assert.are.same("lua" .. path.sep .. "plenary", Path:new("lua", "plenary").filename)
   end)
 
+  describe(".exists()", function()
+    it_cross_plat("finds files that exist", function()
+      assert.are.same(true, Path:new("README.md"):exists())
+    end)
+
+    it_cross_plat("returns false for files that do not exist", function()
+      assert.are.same(false, Path:new("asdf.md"):exists())
+    end)
+  end)
+
   describe(".is_dir()", function()
     it_cross_plat("should find directories that exist", function()
       assert.are.same(true, Path:new("lua"):is_dir())
@@ -242,4 +252,86 @@ describe("Path2", function()
       assert.are.same(false, Path:new("README.md"):is_dir())
     end)
   end)
+
+  describe(".is_file()", function()
+    it_cross_plat("should not allow directories", function()
+      assert.are.same(true, not Path:new("lua"):is_file())
+    end)
+
+    it_cross_plat("should return false when the file does not exist", function()
+      assert.are.same(true, not Path:new("asdf"):is_file())
+    end)
+
+    it_cross_plat("should show files as file", function()
+      assert.are.same(true, Path:new("README.md"):is_file())
+    end)
+  end)
+
+  -- describe(":make_relative", function()
+  --   local root = iswin and "c:\\" or "/"
+  --   it_cross_plat("can take absolute paths and make them relative to the cwd", function()
+  --     local p = Path:new { "lua", "plenary", "path.lua" }
+  --     local absolute = vim.loop.cwd() .. path.sep .. p.filename
+  --     local relative = Path:new(absolute):make_relative()
+  --     assert.are.same(p.filename, relative)
+  --   end)
+
+  --   it_cross_plat("can take absolute paths and make them relative to a given path", function()
+  --     local r = Path:new { root, "home", "prime" }
+  --     local p = Path:new { "aoeu", "agen.lua" }
+  --     local absolute = r.filename .. path.sep .. p.filename
+  --     local relative = Path:new(absolute):make_relative(r.filename)
+  --     assert.are.same(relative, p.filename)
+  --   end)
+
+  --   it_cross_plat("can take double separator absolute paths and make them relative to the cwd", function()
+  --     local p = Path:new { "lua", "plenary", "path.lua" }
+  --     local absolute = vim.loop.cwd() .. path.sep .. path.sep .. p.filename
+  --     local relative = Path:new(absolute):make_relative()
+  --     assert.are.same(relative, p.filename)
+  --   end)
+
+  --   it_cross_plat("can take double separator absolute paths and make them relative to a given path", function()
+  --     local r = Path:new { root, "home", "prime" }
+  --     local p = Path:new { "aoeu", "agen.lua" }
+  --     local absolute = r.filename .. path.sep .. path.sep .. p.filename
+  --     local relative = Path:new(absolute):make_relative(r.filename)
+  --     assert.are.same(relative, p.filename)
+  --   end)
+
+  --   it_cross_plat("can take absolute paths and make them relative to a given path with trailing separator", function()
+  --     local r = Path:new { root, "home", "prime" }
+  --     local p = Path:new { "aoeu", "agen.lua" }
+  --     local absolute = r.filename .. path.sep .. p.filename
+  --     local relative = Path:new(absolute):make_relative(r.filename .. path.sep)
+  --     assert.are.same(relative, p.filename)
+  --   end)
+
+  --   it_cross_plat("can take absolute paths and make them relative to the root directory", function()
+  --     local p = Path:new { "home", "prime", "aoeu", "agen.lua" }
+  --     local absolute = root .. p.filename
+  --     local relative = Path:new(absolute):make_relative(root)
+  --     assert.are.same(relative, p.filename)
+  --   end)
+
+  --   it_cross_plat("can take absolute paths and make them relative to themselves", function()
+  --     local p = Path:new { root, "home", "prime", "aoeu", "agen.lua" }
+  --     local relative = Path:new(p.filename):make_relative(p.filename)
+  --     assert.are.same(relative, ".")
+  --   end)
+
+  --   it_cross_plat("should not truncate if path separator is not present after cwd", function()
+  --     local cwd = "tmp" .. path.sep .. "foo"
+  --     local p = Path:new { "tmp", "foo_bar", "fileb.lua" }
+  --     local relative = Path:new(p.filename):make_relative(cwd)
+  --     assert.are.same(p.filename, relative)
+  --   end)
+
+  --   it_cross_plat("should not truncate if path separator is not present after cwd and cwd ends in path sep", function()
+  --     local cwd = "tmp" .. path.sep .. "foo" .. path.sep
+  --     local p = Path:new { "tmp", "foo_bar", "fileb.lua" }
+  --     local relative = Path:new(p.filename):make_relative(cwd)
+  --     assert.are.same(p.filename, relative)
+  --   end)
+  -- end)
 end)