absolute: remove expand_tilde option

This was an anti-pattern, as the user can trivially call expanduser in
the same line

canonical, resolve: remove expand_tilde option

This was an anti-pattern, as the user can trivially call expanduser in
the same line

Author: scivision

+stdlib/absolute.m

@@ -9,54 +9,41 @@
 %%% Inputs
 % * p: path to make absolute
 % * base: if present, base on this instead of cwd
-% * expand_tilde: expand ~ to username if present
 %%% Outputs
 % * c: absolute path
 %
 % does not normalize path
 % non-existant path is made absolute relative to pwd
 
-function c = absolute(p, base, expand_tilde)
+function c = absolute(p, base)
 arguments
   p {mustBeTextScalar}
-  base {mustBeTextScalar} = ''
-  expand_tilde (1,1) logical = true
-end
-
-if expand_tilde
-  c = stdlib.expanduser(p);
-else
-  c = p;
+  base {mustBeTextScalar} = pwd()
 end
 
+c = p;
 if stdlib.is_absolute(c)
  return
 end
 
-if strlength(base) == 0
-  b = pwd();
-elseif expand_tilde
-  b = stdlib.expanduser(base);
+if strlength(base)
+  b = stdlib.absolute(base);
 else
-  b = base;
-end
-
-if ~stdlib.is_absolute(b)
-  b = strcat(pwd(), '/', b);
+  b = pwd();
 end
 
-if strlength(c) == 0
-  c = b;
-else
+if strlength(c)
   c = strcat(b, '/', c);
+else
+  c = b;
 end
 
-if isstring(p)
+if isstring(p) || isstring(base)
   c = string(c);
 end
 
 end
 
 
-%!assert(absolute('', '', false), pwd)
-%!assert(absolute('a/b', '', false), strcat(pwd(), '/a/b'))
+%!assert(absolute('', ''), pwd)
+%!assert(absolute('a/b', ''), strcat(pwd(), '/a/b'))

+stdlib/canonical.m

@@ -8,44 +8,36 @@
 %
 %%% Inputs
 % * p: path to make canonical
-% * expand_tilde: expand ~ to username if present
 %%% Outputs
 % * c: canonical path, if determined
 
-function c = canonical(p, expand_tilde)
+function c = canonical(p)
 arguments
   p {mustBeTextScalar}
-  expand_tilde (1,1) logical = true
 end
 
 c = "";
 
-if expand_tilde
-  e = stdlib.expanduser(p);
-else
-  e = p;
-end
-
-if ~strlength(e) || (ispc() && (startsWith(e, {'\\', '//'})))
+if ~strlength(p) || (ispc() && (startsWith(p, {'\\', '//'})))
   % UNC path is not canonicalized
   return
 end
 
 if stdlib.isoctave()
 % empty if any component of path does not exist
-  c = canonicalize_file_name(e);
+  c = canonicalize_file_name(p);
 else
 % errors if any component of path does not exist.
 % disp("builtin")
   try %#ok<TRYNC>
-    c = builtin('_canonicalizepath', e);
+    c = builtin('_canonicalizepath', p);
   end
 end
 
 c = stdlib.posix(c);
 
 if ~strlength(c)
-  c = stdlib.normalize(e);
+  c = stdlib.normalize(p);
 end
 
 if isstring(p)
@@ -54,5 +46,5 @@
 
 end
 
-%!assert(canonical("", 1), "")
-%!assert(canonical("~", 1), homedir())
+%!assert(canonical(""), "")
+%!assert(canonical("~"), homedir())

+stdlib/is_regular_file.m

@@ -7,7 +7,7 @@
 end
 
 % needs absolute()
-p = stdlib.absolute(p, '', false);
+p = stdlib.absolute(p);
 
 op = javaPathObject(p);
 opt = javaLinkOption();

+stdlib/is_symlink.m

@@ -11,7 +11,7 @@
   ok = isSymbolicLink(p);
 catch e
   switch e.identifier
-    case "MATLAB:UndefinedFunction", ok = java.nio.file.Files.isSymbolicLink(javaPathObject(stdlib.absolute(p, '', false)));
+    case "MATLAB:UndefinedFunction", ok = java.nio.file.Files.isSymbolicLink(javaPathObject(stdlib.absolute(p)));
     case "Octave:undefined-function", ok = S_ISLNK(stat(p).mode);
     otherwise, rethrow(e)
   end

+stdlib/read_symlink.m

@@ -19,7 +19,7 @@
       if stdlib.is_symlink(p)
         % must be absolute path
         % must not be .canonical or symlink is gobbled!
-        r = stdlib.absolute(p, '', false);
+        r = stdlib.absolute(p);
 
         % https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Files.html#readSymbolicLink(java.nio.file.Path)
         r = java.nio.file.Files.readSymbolicLink(javaPathObject(r)).string;

+stdlib/resolve.m

@@ -3,21 +3,18 @@
 % effectively canonical(absolute(p))
 %%% Inputs
 % * p: path to make absolute
-% * expand_tilde: expand ~ to username if present
 %%% Outputs
 % * c: resolved path
 % distinct from canonical(), resolve() always returns absolute path
 % non-existant path is made absolute relative to pwd
 
-function r = resolve(p, expand_tilde)
+function r = resolve(p)
 arguments
   p {mustBeTextScalar}
-  expand_tilde (1,1) logical = true
 end
 
-
-r = stdlib.canonical(stdlib.absolute(p, '', expand_tilde), false);
+r = stdlib.canonical(stdlib.absolute(p));
 
 end
 
-%!assert (resolve('', 1), stdlib.posix(pwd()))
+%!assert (resolve(''), stdlib.posix(pwd()))

+stdlib/samepath.m

@@ -23,7 +23,7 @@
 % https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Files.html#isSameFile(java.nio.file.Path,java.nio.file.Path)
 
 issame = stdlib.exists(path1) && stdlib.exists(path2) && ...
-         strcmp(stdlib.canonical(path1, false), stdlib.canonical(path2, false));
+         strcmp(stdlib.canonical(path1), stdlib.canonical(path2));
 
 end
 

test/TestAbsolute.m

@@ -29,10 +29,6 @@ function test_absolute1arg(tc, p1)
   r = strcat(r, '/', p1);
 end
 
-if isstring(p1)
-  r = string(r);
-end
-
 tc.verifyEqual(stdlib.absolute(p1), r)
 end
 
@@ -49,10 +45,6 @@ function test_absolute2arg(tc, p2)
   r = strcat(r, '/', p2{1});
 end
 
-if isstring(p2{1})
-  r = string(r);
-end
-
 tc.verifyEqual(stdlib.absolute(p2{1}, p2{2}), r)
 end
 

test/TestCanonical.m

@@ -5,13 +5,8 @@
 {"", ""}, ...
 {"not-exist", "not-exist"}, ...
 {"a/../b", "b"}, ...
-{'~', stdlib.homedir()}, ...
-{"~", string(stdlib.homedir())}, ...
-{'~/', stdlib.homedir()}, ...
-{"~/", string(stdlib.homedir())}, ...
-{"~/..", string(stdlib.parent(stdlib.homedir()))}, ...
 {mfilename("fullpath") + ".m/..", string(stdlib.parent(mfilename("fullpath")))}, ...
-{"~/not-exist/a/..", stdlib.homedir() + "/not-exist"}, ...
+{"not-exist/a/..", "not-exist"}, ...
 {"./not-exist", "not-exist"}, ...
 {"../not-exist", "../not-exist"}
 };
@@ -21,7 +16,7 @@
 methods(Test)
 
 function test_canonical(tc, p)
-tc.verifyEqual(stdlib.canonical(p{1}, true), p{2})
+tc.verifyEqual(stdlib.canonical(p{1}), p{2})
 end
 
 end

test/TestResolve.m

@@ -13,31 +13,31 @@ function test_resolve_relative(tc)
 
 % all non-existing files
 
-pabs = stdlib.resolve('2foo', true);
-pabs2 = stdlib.resolve('4foo', true);
+pabs = stdlib.resolve('2foo');
+pabs2 = stdlib.resolve('4foo');
 tc.verifyThat(pabs, ~StartsWithSubstring("2"))
 tc.verifyTrue(strncmp(pabs, pabs2, 2))
 
-par1 = stdlib.resolve("../2foo", true);
+par1 = stdlib.resolve("../2foo");
 tc.verifyNotEmpty(par1)
 tc.verifyThat(par1, ~ContainsSubstring(".."))
 
-par2 = stdlib.resolve("../4foo", true);
+par2 = stdlib.resolve("../4foo");
 tc.verifyTrue(strncmp(par2, pabs2, 2))
 
-pt1 = stdlib.resolve("bar/../2foo", true);
+pt1 = stdlib.resolve("bar/../2foo");
 tc.verifyNotEmpty(pt1)
 tc.verifyThat(pt1, ~ContainsSubstring(".."))
 
-va = stdlib.resolve("2foo", true);
-vb = stdlib.resolve("4foo", true);
+va = stdlib.resolve("2foo");
+vb = stdlib.resolve("4foo");
 tc.verifyThat(va, ~StartsWithSubstring("2"))
 tc.verifyTrue(strncmp(va, vb, 2))
 
 end
 
 function test_resolve_fullpath(tc, p)
-tc.verifyEqual(stdlib.resolve(p{1}, true), p{2})
+tc.verifyEqual(stdlib.resolve(p{1}), p{2})
 end
 
 end
@@ -50,14 +50,11 @@ function test_resolve_fullpath(tc, p)
 p = {...
 {'', stdlib.posix(pwd())}, ...
 {"", string(stdlib.posix(pwd()))}, ...
-{'~', stdlib.homedir()}, ...
-{"~", string(stdlib.homedir())}, ...
-{'~/', stdlib.homedir()}, ...
-{"~/", string(stdlib.homedir())}, ...
-{"~/..", string(stdlib.parent(stdlib.homedir()))}, ...
-{mfilename("fullpath") + ".m/..", string(stdlib.parent(mfilename("fullpath")))}, ...
 {"a/../b", stdlib.posix(pwd()) + "/b"}, ...
 {"not-exist", stdlib.posix(pwd()) + "/not-exist"}, ...
-{"~/not-exist/a/..", stdlib.homedir() + "/not-exist"}...
+{"./not-exist/a/..", stdlib.posix(pwd()) + "/not-exist"}...
 };
+
+p{end+1} = {strcat(mfilename("fullpath"), '.m/..'), stdlib.parent(mfilename("fullpath"))};
+p{end+1} = cellfun(@string, p{end});
 end