add proximate_to, is_subdir

Author: scivision

+stdlib/+fileio/is_subdir.m

@@ -0,0 +1,11 @@
+function yes = is_subdir(subdir, dir)
+arguments
+  subdir (1,1) string
+  dir (1,1) string
+end
+
+r = stdlib.fileio.relative_to(dir, subdir);
+
+yes = strlength(r) > 0 && r ~= "." && ~startsWith(r, "..");
+
+end

+stdlib/+fileio/proximate_to.m

@@ -0,0 +1,14 @@
+function r = proximate_to(base, other)
+arguments
+  base (1,1) string
+  other (1,1) string
+end
+
+r = stdlib.fileio.relative_to(base, other);
+if strlength(r) > 0
+  return;
+end
+
+r = other;
+
+end

+stdlib/+fileio/relative_to.m

@@ -8,22 +8,20 @@
 base = stdlib.fileio.normalize(base);
 other = stdlib.fileio.normalize(other);
 
-if base == "" || other == ""
-  r = "";
-elseif base == other
+if base == other
   r = ".";
 else
-    b = java.io.File(base).toPath();
-    o = java.io.File(other).toPath();
-    try
-        r = stdlib.fileio.posix(b.relativize(o));
-    catch e
-      if contains(e.message, 'java.lang.IllegalArgumentException')
-        r = "";
-      else
-        rethrow(e);
-      end
+  b = java.io.File(base).toPath();
+  o = java.io.File(other).toPath();
+  try
+    r = stdlib.fileio.posix(b.relativize(o));
+  catch e
+    if contains(e.message, 'java.lang.IllegalArgumentException')
+      r = "";
+    else
+      rethrow(e);
     end
+  end
 end
 
 end

+stdlib/is_subdir.m

@@ -0,0 +1,9 @@
+function yes = is_subdir(subdir, dir)
+arguments
+  subdir (1,1) string
+  dir (1,1) string
+end
+
+yes = stdlib.fileio.is_subdir(subdir, dir);
+
+end

+stdlib/proximate_to.m

@@ -0,0 +1,9 @@
+function r = proximate_to(base, other)
+arguments
+  base (1,1) string
+  other (1,1) string
+end
+
+r = stdlib.fileio.proximate_to(base, other);
+
+end

+stdlib/relative_to.m

@@ -4,10 +4,6 @@
   other (1,1) string
 end
 
-if base == "" && other == ""
-  r = ".";  % like C++ std::filesystem::relative
-else
-  r = stdlib.fileio.relative_to(base, other);
-end
+r = stdlib.fileio.relative_to(base, other);
 
 end

test/TestFileImpure.m

@@ -1,73 +1,88 @@
 classdef TestFileImpure < matlab.unittest.TestCase
 
-methods(TestClassSetup)
-
-function setup_path(tc)
-import matlab.unittest.fixtures.PathFixture
-cwd = fileparts(mfilename("fullpath"));
-top = fullfile(cwd, "..");
-tc.applyFixture(PathFixture(top))
+properties (ClassSetupParameter)
+  classToTest = {"TestFileImpure"};
+end
 
+properties(TestParameter)
+in_exists = {pwd, string(mfilename("fullpath"))+".m", "not-exists"}
+ref_exists = {true, true, false}
+% on CI matlabroot can be writable!
+in_is_write = {pwd, "not-exists"};
+ref_is_write = {true, false}
+in_expand = {"", "~abc", "~", "~/foo"}
+ref_expand
+in_same = {"", tempname, "~/b/..", "."}
+other_same = {"", tempname, "~/c/..", fullfile(pwd, "a/..")}
+ref_same = {false, false, true, true}
 end
 
+properties
+tobj
 end
 
-methods (Test)
 
-function test_exists(tc)
+methods (TestParameterDefinition, Static)
 
-tc.verifyTrue(stdlib.exists(pwd))
-tc.verifyTrue(stdlib.exists(string(mfilename("fullpath"))+".m"))
-tc.verifyFalse(stdlib.exists("not-exists"))
+function ref_expand = init_expand(classToTest) %#ok<INUSD>
+cwd = fileparts(mfilename("fullpath"));
+top = fullfile(cwd, "..");
+addpath(top)
 
+ref_expand = {"", "~abc", stdlib.fileio.homedir, stdlib.join(stdlib.fileio.homedir, "foo")};
+end
 end
 
 
-function test_is_readable(tc)
-
-tc.verifyTrue(stdlib.is_readable(pwd))
-tc.verifyTrue(stdlib.is_readable(string(mfilename("fullpath"))+".m"))
-tc.verifyFalse(stdlib.is_readable("not-exists"))
+methods(TestClassSetup)
 
+function classSetup(tc, classToTest)
+constructor = str2func(classToTest);
+tc.tobj = constructor();
 end
 
-
-function test_is_writable(tc)
-
-tc.verifyTrue(stdlib.is_writable(pwd))
-% tc.verifyFalse(stdlib.is_writable(matlabroot))  % on CI this can be writable!
-tc.verifyFalse(stdlib.is_writable("not-exists"))
+function setup_path(tc)
+import matlab.unittest.fixtures.PathFixture
+cwd = fileparts(mfilename("fullpath"));
+top = fullfile(cwd, "..");
+tc.applyFixture(PathFixture(top))
+end
 
 end
 
+methods (Test, ParameterCombination = 'sequential')
 
+function test_exists(tc, in_exists, ref_exists)
+tc.verifyEqual(stdlib.exists(in_exists), ref_exists)
+end
 
-function test_expanduser(tc)
 
-tc.verifyEqual(stdlib.expanduser(""), "")
+function test_is_readable(tc, in_exists, ref_exists)
+tc.verifyEqual(stdlib.is_readable(in_exists), ref_exists)
+end
 
-tc.verifyEqual(stdlib.expanduser("~abc"), "~abc")
 
-h = stdlib.fileio.homedir();
-tc.verifyEqual(stdlib.expanduser("~"), h)
+function test_is_writable(tc, in_is_write, ref_is_write)
+tc.verifyEqual(stdlib.is_writable(in_is_write), ref_is_write)
+end
 
-e = stdlib.expanduser("~/foo");
-tc.verifyEqual(e, stdlib.fileio.join(h, "foo"))
 
+function test_expanduser(tc, in_expand, ref_expand)
+tc.verifyEqual(stdlib.expanduser(in_expand), ref_expand)
 end
 
 
 function test_touch_modtime(tc)
 
 fn = tempname;
 tc.verifyTrue(stdlib.touch(fn))
-
 t0 = stdlib.get_modtime(fn);
-pause(1.1)
+
+pause(0.4)  % empirical to avoid failing >=
 tc.verifyTrue(stdlib.set_modtime(fn))
 t1 = stdlib.get_modtime(fn);
 
-tc.verifyGreaterThan(t1, t0)
+tc.verifyGreaterThanOrEqual(t1, t0)
 
 end
 
@@ -115,7 +130,6 @@ function test_canonical(tc)
 tc.verifyThat(pabs, StartsWithSubstring("2foo"))
 
 par1 = stdlib.canonical("../2foo");
-tc.verifyNotEmpty(par1)
 tc.verifyThat(par1, StartsWithSubstring(".."))
 
 pt1 = stdlib.canonical("bar/../2foo");
@@ -194,12 +208,8 @@ function test_makedir(tc)
 end
 
 
-function test_samepath(tc)
-
-tc.verifyFalse(stdlib.samepath("", ""), "empty not same")
-tc.verifyFalse(stdlib.samepath(tempname, tempname), "tempname not same")
-tc.verifyTrue(stdlib.samepath("~/b/..", "~/c/.."), "tilde path ..")
-tc.verifyTrue(stdlib.samepath(".", fullfile(pwd, "a/..")), "dot path ..")
+function test_samepath(tc, in_same, other_same, ref_same)
+tc.verifyEqual(stdlib.samepath(in_same, other_same), ref_same)
 end