fix: path normalization works with esoteric usernames (#290)

* fix: path normalization works with esoteric usernames

Usernames with dashes at the end are perfectly valid unix user names,
but they're seen as a regular expression pattern in Lua. Switch to using
string.find instead of string.gsub to avoid the pattern matching issue.

* Fix syntax error

Using end here is no good, even though it worked in the luajit repl. 😆

* Fix typo in spec name

* Clean the path we send to _normalize_path

Also fix the specs to match the new behavior.

Author: mattr-

lua/plenary/path.lua

@@ -347,10 +347,14 @@ function Path:normalize(cwd)
   self:make_relative(cwd)
 
   -- Substitute home directory w/ "~"
-  local removed_path_sep = path.home:gsub(path.sep .. "$", "")
-  self.filename = self.filename:gsub("^" .. removed_path_sep, "~", 1)
+  -- string.gsub is not useful here because usernames with dashes at the end
+  -- will be seen as a regexp pattern rather than a raw string
+  local start, finish = string.find(self.filename, path.home, 1, true)
+  if start == 1 then
+    self.filename = "~" .. path.sep .. string.sub(self.filename, (finish + 1), -1)
+  end
 
-  return _normalize_path(self.filename, self._cwd)
+  return _normalize_path(clean(self.filename), self._cwd)
 end
 
 local function shorten_len(filename, len, exclude)

tests/plenary/path_spec.lua

@@ -212,7 +212,7 @@ describe("Path", function()
       assert.are.same("/tmp/lua/plenary/path.lua", p:normalize())
     end)
 
-    it("can normalize ~ when file is within home directory (traling slash)", function()
+    it("can normalize ~ when file is within home directory (trailing slash)", function()
       local home = "/home/test/"
       local p = Path:new { home, "./test_file" }
       p.path.home = home
@@ -227,6 +227,14 @@ describe("Path", function()
       p._cwd = "/tmp/lua"
       assert.are.same("~/test_file", p:normalize())
     end)
+
+    it("handles usernames with a dash at the end", function()
+      local home = "/home/mattr-"
+      local p = Path:new { home, "test_file" }
+      p.path.home = home
+      p._cwd = "/tmp/lua"
+      assert.are.same("~/test_file", p:normalize())
+    end)
   end)
 
   describe(":shorten", function()