add resolve() distinct from canonical()

Author: scivision

+stdlib/+fileio/canonical.m

@@ -17,14 +17,23 @@
 end
 
 if ~stdlib.fileio.is_absolute_path(c)
-  % .toAbsolutePath() default is Documents/Matlab, which is probably not wanted.
-  c = fullfile(pwd, c);
+  if isfile(c) || isfolder(c)
+    % workaround Java/Matlab limitations
+    c = fullfile(pwd, c);
+  else
+    % for non-existing path, return normalized relative path
+    % like C++ filesystem weakly_canonical()
+    c = stdlib.fileio.normalize(c);
+    return
+  end
 end
 
 % similar benchmark time as java method
 % REQUIRES path to exist, while java method does not.
-% abspath = builtin('_canonicalizepath', abspath);
+% c = builtin('_canonicalizepath', c);
 
-c = string(java.io.File(c).getCanonicalPath());
+% https://docs.oracle.com/javase/9/docs/api/java/io/File.html#getCanonicalPath--
+
+c = stdlib.fileio.posix(string(java.io.File(c).getCanonicalPath()));
 
 end % function

+stdlib/+fileio/normalize.m

@@ -9,6 +9,7 @@
   return
 end
 
-n = string(java.io.File(stdlib.fileio.expanduser(n)).toPath().normalize());
+n = stdlib.fileio.posix(string(...
+    java.io.File(stdlib.fileio.expanduser(n)).toPath().normalize()));
 
 end

+stdlib/+fileio/resolve.m

@@ -0,0 +1,33 @@
+function c = resolve(p)
+% distinct from canonical(), resolve() always returns absolute path
+% non-existant path is made absolute relative to pwd
+arguments
+  p string {mustBeScalarOrEmpty}
+end
+
+% have to expand ~ first (like C++ filesystem::path::absolute)
+c = stdlib.fileio.expanduser(p);
+
+if isempty(c)
+  return
+end
+
+if ispc && startsWith(c, "\\")
+  % UNC path is not canonicalized
+  return
+end
+
+if ~stdlib.fileio.is_absolute_path(c)
+  % .toAbsolutePath() default is Documents/Matlab, which is probably not wanted.
+  c = fullfile(pwd, c);
+end
+
+% similar benchmark time as java method
+% REQUIRES path to exist, while java method does not.
+% c = builtin('_canonicalizepath', c);
+
+% https://docs.oracle.com/javase/9/docs/api/java/io/File.html#getCanonicalPath--
+
+c = stdlib.fileio.posix(string(java.io.File(c).getCanonicalPath()));
+
+end % function

+stdlib/+test/TestFileImpure.m

@@ -23,14 +23,12 @@ function test_makedir(tc)
 
 
 function test_samepath(tc)
-import stdlib.fileio.samepath
-tc.assumeTrue(usejava("jvm"), "Java required")
 
-tc.verifyEmpty(samepath(string.empty, string.empty))
-tc.verifyTrue(samepath("", ""))
-tc.verifyFalse(samepath(tempname, tempname))
-tc.verifyTrue(samepath("~/b/..", "~/c/.."), "tilde path ..")
-tc.verifyTrue(samepath(".", "a/.."))
+tc.verifyEmpty(stdlib.samepath(string.empty, string.empty))
+tc.verifyTrue(stdlib.samepath("", ""))
+tc.verifyFalse(stdlib.samepath(tempname, tempname))
+tc.verifyTrue(stdlib.samepath("~/b/..", "~/c/.."), "tilde path ..")
+tc.verifyTrue(stdlib.samepath(".", fullfile(pwd, "a/..")))
 end
 
 

+stdlib/+test/TestFilePure.m

@@ -93,34 +93,76 @@ function test_absolute_path(tc)
 
 
 function test_canonical(tc)
-
+import matlab.unittest.fixtures.TemporaryFolderFixture
+import matlab.unittest.fixtures.CurrentFolderFixture
 import stdlib.canonical
+
 tc.assumeTrue(usejava("jvm"), "Java required")
 
+td = tc.applyFixture(TemporaryFolderFixture).Folder;
+tc.applyFixture(CurrentFolderFixture(td))
+
+% all non-existing files
 tc.verifyEmpty(canonical(string.empty))
-tc.verifyEqual(canonical(""), string(pwd))
+tc.verifyEqual(canonical(""), "")
 
 pabs = canonical('2foo');
-pabs2 = canonical('4foo');
+tc.verifyTrue(startsWith(pabs, "2foo"))
+
+par1 = canonical("../2foo");
+tc.verifyNotEmpty(par1)
+tc.verifyTrue(startsWith(par1, ".."))
+
+pt1 = canonical("bar/../2foo");
+tc.verifyEqual(pt1, "2foo")
+
+% test existing file
+r = stdlib.fileio.parent(mfilename('fullpath'));
+rp = fullfile(r, "..");
+tc.verifyEqual(canonical(rp), stdlib.fileio.parent(r))
+
+end
+
+
+function test_resolve(tc)
+import matlab.unittest.fixtures.TemporaryFolderFixture
+import matlab.unittest.fixtures.CurrentFolderFixture
+import stdlib.resolve
+tc.assumeTrue(usejava("jvm"), "Java required")
+
+td = tc.applyFixture(TemporaryFolderFixture).Folder;
+tc.applyFixture(CurrentFolderFixture(td))
+
+% all non-existing files
+tc.verifyEmpty(resolve(string.empty))
+tc.verifyEqual(resolve(""), string(stdlib.fileio.posix(pwd)))
+
+pabs = resolve('2foo');
+pabs2 = resolve('4foo');
 tc.verifyFalse(startsWith(pabs, "2"))
 tc.verifyTrue(strncmp(pabs, pabs2, 2))
 
-par1 = canonical("../2foo");
+par1 = resolve("../2foo");
 tc.verifyNotEmpty(par1)
 tc.verifyFalse(contains(par1, ".."))
 
-par2 = canonical("../4foo");
+par2 = resolve("../4foo");
 tc.verifyTrue(strncmp(par2, pabs2, 2))
 
-pt1 = canonical("bar/../2foo");
+pt1 = resolve("bar/../2foo");
 tc.verifyNotEmpty(pt1)
 tc.verifyFalse(contains(pt1, ".."))
 
-va = canonical("2foo");
-vb = canonical("4foo");
+va = resolve("2foo");
+vb = resolve("4foo");
 tc.verifyFalse(startsWith(va, "2"))
 tc.verifyTrue(strncmp(va, vb, 2))
 
+% test existing file
+r = stdlib.fileio.parent(mfilename('fullpath'));
+rp = fullfile(r, "..");
+tc.verifyEqual(resolve(rp), stdlib.fileio.parent(r))
+
 end
 
 

+stdlib/+test/TestWindowsCOM.m

@@ -6,7 +6,7 @@ function test_shortname(tc)
 
 tc.assumeTrue(ispc, "Windows only")
 
-test_file = string(fullfile(getenv("LocalAppData"), 'Microsoft\WindowsApps\notepad.exe'));
+test_file = stdlib.fileio.posix(fullfile(getenv("LocalAppData"), "Microsoft/WindowsApps/notepad.exe"));
 tc.assumeTrue(isfile(test_file))
 
 short = stdlib.fileio.windows_shortname(test_file);

+stdlib/canonical.m

@@ -1,6 +1,7 @@
 function c = canonical(p)
 %% canonical(p)
-% path need not exist, but canonical path is returned
+% If exists, canonical absolute path is returned
+% if path does not exist, normalized relative path is returned
 %
 % NOTE: some network file systems are not resolvable by Matlab Java
 % subsystem, but are sometimes still valid--so return

+stdlib/resolve.m

@@ -0,0 +1,23 @@
+function c = resolve(p)
+%% resolve(p)
+% path need not exist--absolute path will be relative to pwd if not exist
+% if path exists, same result as canonical()
+%
+% NOTE: some network file systems are not resolvable by Matlab Java
+% subsystem, but are sometimes still valid--so return
+% unmodified path if this occurs.
+%
+% This also resolves Windows short paths to full long paths.
+%
+%%% Inputs
+% * p: path to resolve
+%%% Outputs
+% * c: resolved path
+
+arguments
+  p string {mustBeScalarOrEmpty}
+end
+
+c = stdlib.fileio.resolve(p);
+
+end