path: keep order of existing entries in PATH

Implements suggestion by @FSMaxB:

> Add an additional flag to util.cleanup_path that specifies if the cleanup
> happens from the right or from the left. If append is true, clean up from the
> left, otherwise clean up from the right.

Fixes #763.

3 files changed, 41 insertions, 12 deletions

diff --git a/spec/util_spec.lua b/spec/util_spec.lua
index 930a5aea..b1693cfa 100644
--- a/spec/util_spec.lua
+++ b/spec/util_spec.lua
@@ -157,16 +157,34 @@ describe("Luarocks util test #unit", function()
    end)
       
    describe("core.util.cleanup_path", function()
+     it("does not change order of existing items of prepended path", function()
+        local sys_path = '/usr/local/bin;/usr/bin'
+        local lr_path = '/home/user/.luarocks/bin;/usr/bin'
+        local path = lr_path .. ';' .. sys_path
+
+        local result = core_util.cleanup_path(path, ';', '5.3', false)
+        assert.are.equal('/home/user/.luarocks/bin;/usr/local/bin;/usr/bin', result)
+     end)
+
+     it("does not change order of existing items of appended path", function()
+        local sys_path = '/usr/local/bin;/usr/bin'
+        local lr_path = '/home/user/.luarocks/bin;/usr/bin'
+        local path = sys_path .. ';' .. lr_path
+
+        local result = core_util.cleanup_path(path, ';', '5.3', true)
+        assert.are.equal('/usr/local/bin;/usr/bin;/home/user/.luarocks/bin', result)
+     end)
+
      it("rewrites versions that do not match the provided version", function()
         local expected = 'a/b/lua/5.3/?.lua;a/b/c/lua/5.3/?.lua'
         local result = core_util.cleanup_path('a/b/lua/5.2/?.lua;a/b/c/lua/5.3/?.lua', ';', '5.3')
         assert.are.equal(expected, result)
      end)
 
-      it("does not rewrite versions for which the provided version is a substring", function()
-         local expected = 'a/b/lua/5.3/?.lua;a/b/c/lua/5.3.4/?.lua'
-         local result = core_util.cleanup_path('a/b/lua/5.2/?.lua;a/b/c/lua/5.3.4/?.lua', ';', '5.3')
-         assert.are.equal(expected, result)
-      end)
+     it("does not rewrite versions for which the provided version is a substring", function()
+        local expected = 'a/b/lua/5.3/?.lua;a/b/c/lua/5.3.4/?.lua'
+        local result = core_util.cleanup_path('a/b/lua/5.2/?.lua;a/b/c/lua/5.3.4/?.lua', ';', '5.3')
+        assert.are.equal(expected, result)
+     end)
    end)
 end)
diff --git a/src/luarocks/cmd/path.lua b/src/luarocks/cmd/path.lua
index 9046cd2e..bb383ad9 100644
--- a/src/luarocks/cmd/path.lua
+++ b/src/luarocks/cmd/path.lua
@@ -60,10 +60,10 @@ function path_cmd.command(flags)
    
    local lpath_var, lcpath_var = util.lua_path_variables()
 
-   util.printout(fs.export_cmd(lpath_var, util.cleanup_path(lr_path, ';', cfg.lua_version)))
-   util.printout(fs.export_cmd(lcpath_var, util.cleanup_path(lr_cpath, ';', cfg.lua_version)))
+   util.printout(fs.export_cmd(lpath_var, util.cleanup_path(lr_path, ';', cfg.lua_version, flags["append"])))
+   util.printout(fs.export_cmd(lcpath_var, util.cleanup_path(lr_cpath, ';', cfg.lua_version, flags["append"])))
    if not flags["no-bin"] then
-      util.printout(fs.export_cmd("PATH", util.cleanup_path(lr_bin, path_sep)))
+      util.printout(fs.export_cmd("PATH", util.cleanup_path(lr_bin, path_sep, nil, flags["append"])))
    end
    return true
 end
diff --git a/src/luarocks/core/util.lua b/src/luarocks/core/util.lua
index 1499dc62..6a306026 100644
--- a/src/luarocks/core/util.lua
+++ b/src/luarocks/core/util.lua
@@ -165,13 +165,23 @@ end
 -- @param list string: A path string (from $PATH or package.path)
 -- @param sep string: The separator
 -- @param lua_version (optional) string: The Lua version to use.
-function util.cleanup_path(list, sep, lua_version)
+-- @param keep_last (optional) if true, keep last occurrence in case
+-- of duplicates; otherwise keep first occurrence. The default is false.
+function util.cleanup_path(list, sep, lua_version, keep_last)
    assert(type(list) == "string")
    assert(type(sep) == "string")
    local parts = util.split_string(list, sep)
    local final, entries = {}, {}
-   for _, part in ipairs(parts) do
-      part = part:gsub("//", "/")
+   local start, stop, step
+
+   if keep_last then
+      start, stop, step = 1, #parts, 1
+   else
+      start, stop, step = #parts, 1, -1
+   end
+
+   for i = start, stop, step do
+      local part = parts[i]:gsub("//", "/")
       if lua_version then
          part = part:gsub("/lua/([%d.]+)/", function(part_version)
             if part_version:sub(1, #lua_version) ~= lua_version then            
@@ -180,7 +190,8 @@ function util.cleanup_path(list, sep, lua_version)
          end)
       end
       if not entries[part] then
-         table.insert(final, part)
+         local at = keep_last and #final+1 or 1
+         table.insert(final, at, part)
          entries[part] = true
       end
    end