samepath: functionalize improve path, canonical() strict option

remove java as unstable for Java 8 or 11

Author: scivision

+stdlib/+python/samepath.m

@@ -0,0 +1,13 @@
+function y = samepath(path1, path2)
+
+try
+  y = py.os.path.samefile(path1, path2);
+catch e
+  if contains(e.message, "FileNotFoundError")
+    y = false;
+  else
+    rethrow(e);
+  end
+end
+
+end

+stdlib/+sys/samepath.m

@@ -0,0 +1,35 @@
+function y = samepath(path1, path2)
+
+y = false;
+
+if strlength(path1) == 0 || strlength(path2) == 0
+  return
+end
+
+if ispc()
+  c1 = stdlib.canonical(path1, true);
+  c2 = stdlib.canonical(path2, true);
+  y = strlength(c1) > 0 && strcmp(c1, c2);
+  return
+end
+
+if ismac()
+  flag = '-f';
+else
+  flag = '-c';
+end
+
+cmd = "stat " + flag + " %d:%i " + path1 + " && stat " + flag + " %d:%i " + path2;
+
+[s, m] = system(cmd);
+if s ~= 0
+  warning("samepath(%s, %s) failed: %s", path1, path2, m);
+  return
+end
+
+m = splitlines(m);
+assert(length(m) >= 2, "samepath(%s, %s) failed: unexpected output", path1, path2);
+
+y = strcmp(m{1}, m{2});
+
+end

+stdlib/canonical.m

@@ -8,12 +8,14 @@
 %
 %%% Inputs
 % * p: path to make canonical
+% * strict: if true, only return canonical path if it exists. If false, return normalized path if path does not exist.
 %%% Outputs
 % * c: canonical path, if determined
 
-function c = canonical(p)
+function c = canonical(p, strict)
 arguments
   p {mustBeTextScalar}
+  strict logical = false
 end
 
 if strempty(p)
@@ -22,11 +24,11 @@
 end
 
 if isMATLABReleaseOlderThan('R2024a')
-  c = acanon(p);
+  c = acanon(p, strict);
 else
   pth = matlab.io.internal.filesystem.resolvePath(p);
   c = pth.ResolvedPath;
-  if strempty(c)
+  if ~strict && strempty(c)
     c = stdlib.normalize(p);
   end
 end
@@ -36,15 +38,17 @@
 end
 
 
-function c = acanon(p)
+function c = acanon(p, strict)
 
-if strempty(p), c = ''; return, end
+c = "";
+
+if strempty(p), return, end
 
 [s, r] = fileattrib(p);
 
 if s == 1
   c = r.Name;
-else
+elseif ~strict
   c = stdlib.normalize(p);
 end
 

+stdlib/samepath.m

@@ -16,31 +16,10 @@
   path2 {mustBeTextScalar}
 end
 
-y = stdlib.exists(path1) && stdlib.exists(path2);
-
-if ~y, return; end
-
-if ~ispc() && stdlib.isoctave()
-  [r1, e1] = stat(path1);
-  [r2, e2] = stat(path2);
-
-  y = e1 == 0 && e2 == 0 && ...
-      r1.ino == r2.ino && r1.dev == r2.dev;
-
-elseif stdlib.has_dotnet()
-  separators = [System.IO.Path.DirectorySeparatorChar, System.IO.Path.AltDirectorySeparatorChar];
-  f1 = System.IO.Path.GetFullPath(path1).TrimEnd(separators);
-  f2 = System.IO.Path.GetFullPath(path2).TrimEnd(separators);
-  y = System.String.Equals(f1, f2, System.StringComparison.OrdinalIgnoreCase);
-elseif stdlib.java_api() >= 11
-% https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/nio/file/Files.html#isSameFile(java.nio.file.Path,java.nio.file.Path)
-% Java 1.8 is buggy in some corner cases, so we require at least 11.
-  y = java.nio.file.Files.isSameFile(javaPathObject(path1), javaPathObject(path2));
-
+if stdlib.has_python()
+  y = stdlib.python.samepath(path1, path2);
 else
-
-  y = strcmp(stdlib.canonical(path1), stdlib.canonical(path2));
-
+  y = stdlib.sys.samepath(path1, path2);
 end
 
 %!assert(samepath(".", "."))

test/TestFileImpure.m

@@ -1,17 +1,20 @@
 classdef TestFileImpure < matlab.unittest.TestCase
 
 properties(TestParameter)
-p_same = {...
-{"..", "./.."}, ...
-{"..", pwd() + "/.."}, ...
-{pwd(), pwd() + "/."}}
-
 ph = {{0, '"stdin"'}, {1, '"stdout"'}, {2, '"stderr"'}, {fopen(tempname()), ''}}
 
 p_file_size = {mfilename("fullpath") + ".m"}
 end
 
 
+methods(TestClassSetup)
+function pkg_path(tc)
+p = matlab.unittest.fixtures.PathFixture(fileparts(fileparts(mfilename('fullpath'))));
+tc.applyFixture(p)
+end
+end
+
+
 methods (Test, TestTags="impure")
 
 function test_file_size(tc, p_file_size)
@@ -31,28 +34,10 @@ function test_makedir(tc)
 import matlab.unittest.constraints.IsFolder
 d = tempname();
 stdlib.makedir(d)
-tc.assertThat(d, IsFolder)
+tc.verifyThat(d, IsFolder)
 rmdir(d)
 end
 
-%%
-function test_samepath(tc, p_same)
-tc.verifyTrue(stdlib.samepath(p_same{1}, p_same{2}))
-end
-
-function test_samepath_notexist(tc)
-tc.verifyFalse(stdlib.samepath("", ""))
-t = tempname();
-tc.verifyFalse(stdlib.samepath(t, t))
-end
-
-
-function test_get_pid(tc)
-pid = stdlib.get_pid();
-tc.verifyGreaterThan(pid, 0)
-tc.verifyClass(pid, 'uint64')
-end
-
 
 function test_handle2filename(tc, ph)
 tc.verifyEqual(stdlib.handle2filename(ph{1}), ph{2})

test/TestFileSame.m

@@ -0,0 +1,37 @@
+classdef TestFileSame < matlab.unittest.TestCase
+
+properties (TestParameter)
+p_same = {...
+{"..", "./.."}, ...
+{"..", pwd() + "/.."}, ...
+{pwd(), pwd() + "/."}}
+
+same_fun = {@stdlib.samepath, @stdlib.sys.samepath, @stdlib.python.samepath}
+end
+
+methods(TestClassSetup)
+function pkg_path(tc)
+p = matlab.unittest.fixtures.PathFixture(fileparts(fileparts(mfilename('fullpath'))));
+tc.applyFixture(p)
+end
+end
+
+methods(Test)
+
+function test_samepath(tc, p_same, same_fun)
+is_capable(tc, same_fun)
+
+tc.verifyTrue(same_fun(p_same{1}, p_same{2}))
+end
+
+function test_samepath_notexist(tc, same_fun)
+is_capable(tc, same_fun)
+
+tc.verifyFalse(same_fun("", ""))
+t = tempname();
+tc.verifyFalse(same_fun(t, t))
+end
+
+end
+
+end

test/TestSys.m

@@ -32,6 +32,15 @@ function test_is_admin(tc, is_admin_fun)
 tc.verifyNotEmpty(is_admin_fun())
 end
 
+
+function test_get_pid(tc)
+pid = stdlib.get_pid();
+
+tc.verifyGreaterThan(pid, 0)
+tc.verifyClass(pid, 'uint64')
+end
+
+
 function test_get_shell(tc)
 tc.assumeFalse(tc.CI, "get_shell is not tested in CI due to platform differences")
 tc.verifyNotEmpty(stdlib.get_shell())