reorganized as stdlib

Author: scivision

+hdf5nc/TestUnit.m

@@ -0,0 +1,125 @@
+classdef TestFileio < matlab.unittest.TestCase
+
+methods (Test)
+
+function test_expanduser(tc)
+import stdlib.fileio.expanduser
+tc.verifyFalse(startsWith(expanduser('~/foo'), "~"))
+tc.verifyFalse(any(startsWith(expanduser(["~/abc", "~/123"]), "~")))
+
+tc.verifyTrue(endsWith(expanduser('~/foo'), "foo"))
+tc.verifyTrue(all(endsWith(expanduser(["~/abc", "~/123"]), ["abc", "123"])))
+
+tc.verifyEmpty(expanduser(string.empty))
+tc.verifyEqual(expanduser(""), "")
+end
+
+function test_posix(tc)
+import stdlib.fileio.posix
+
+if ispc
+  tc.verifyFalse(contains(posix("c:\foo"), "\"))
+  tc.verifyFalse(any(contains(posix(["x:\123", "d:\abc"]), "\")))
+end
+
+tc.verifyEmpty(posix(string.empty))
+end
+
+function test_is_absolute_path(tc)
+
+import stdlib.fileio.is_absolute_path
+% path need not exist
+tc.verifyTrue(is_absolute_path('~/foo'))
+if ispc
+  tc.verifyTrue(is_absolute_path('x:/foo'))
+  tc.verifyEqual(is_absolute_path(["x:/abc", "x:/123", "", "c"]), [true, true, false, false])
+  tc.verifyTrue(all(is_absolute_path(["x:/abc"; "x:/123"])))
+  tc.verifyFalse(is_absolute_path('/foo'))
+else
+  tc.verifyTrue(is_absolute_path('/foo'))
+end
+
+tc.verifyEmpty(is_absolute_path(string.empty))
+tc.verifyFalse(is_absolute_path(""))
+tc.verifyFalse(is_absolute_path("c"))
+end
+
+function test_absolute_path(tc)
+
+import stdlib.fileio.absolute_path
+
+pabs = absolute_path('2foo');
+pabs2 = absolute_path('4foo');
+tc.verifyFalse(startsWith(pabs, "2"))
+tc.verifyTrue(strncmp(pabs, pabs2, 2))
+
+par1 = absolute_path("../2foo");
+par2 = absolute_path("../4foo");
+tc.verifyFalse(startsWith(par1, ".."))
+tc.verifyTrue(strncmp(par2, pabs2, 2))
+
+pt1 = absolute_path("bar/../2foo");
+tc.verifyFalse(contains(pt1, ".."))
+
+va = absolute_path(["2foo", "4foo"]);
+tc.verifyFalse(any(startsWith(va, "2")))
+vs = extractBefore(va, 2);
+tc.verifyEqual(vs(1), vs(2))
+
+tc.verifyEmpty(absolute_path(string.empty))
+tc.verifyEqual(absolute_path(""), string(pwd))
+end
+
+function test_makedir(tc)
+d = tempname;
+stdlib.fileio.makedir(d)
+tc.assertTrue(isfolder(d))
+end
+
+function test_which(tc)
+import stdlib.fileio.which
+
+tc.verifyEmpty(which(string.empty))
+
+n = "matlab";
+% assumes Matlab in environment variable PATH
+tc.assumeNotEmpty(which(n))
+
+p = fullfile(matlabroot, "bin", n);
+
+% full absolute path
+exe = which(p);
+
+if ispc
+  tc.verifyTrue(endsWith(exe, ".exe"))
+else
+  tc.verifyFalse(endsWith(exe, ".exe"))
+end
+tc.assertTrue(isfile(exe))
+
+end
+
+function test_with_suffix(tc)
+import stdlib.fileio.with_suffix
+tc.verifyEqual(with_suffix("foo.h5", ".nc"), "foo.nc")
+if ~verLessThan("matlab", "9.9")
+% fileparts vectorized in R2020b
+tc.verifyEqual(with_suffix(["foo.h5", "bar.dat"], ".nc"), ["foo.nc", "bar.nc"])
+
+tc.verifyEmpty(with_suffix(string.empty, ".nc"))
+tc.verifyEqual(with_suffix("", ""), "")
+tc.verifyEqual(with_suffix("c", ""), "c")
+tc.verifyEqual(with_suffix("c.nc", ""), "c")
+tc.verifyEqual(with_suffix("", ".nc"), ".nc")
+end
+end
+
+function test_copyfile(tc)
+f1 = tempname;
+fclose(fopen(f1,'w'));
+stdlib.fileio.copyfile(f1, tempdir)
+end
+
+end
+
+end

+stdlib/+fileio/TestFileio.m

@@ -0,0 +1,29 @@
+classdef TestIni < matlab.unittest.TestCase
+
+methods (Test)
+
+function test_example(tc)
+import matlab.unittest.constraints.IsFile
+import stdlib.fileio.ini2struct
+
+cwd = fileparts(mfilename('fullpath'));
+example = fullfile(cwd, "example.ini");
+
+tc.assumeThat(example, IsFile)
+
+s = ini2struct(example);
+tc.verifyClass(s, 'struct')
+tc.verifyEqual(s.DATA.keyNum, 113);
+
+end
+
+function test_lint(tc)
+
+cwd = fileparts(mfilename('fullpath'));
+tc.verifyEmpty(checkcode(fullfile(cwd, "ini2struct.m")))
+
+end
+
+end
+
+end

+stdlib/+fileio/TestIni.m

@@ -0,0 +1,25 @@
+classdef TestIntg < matlab.unittest.TestCase
+
+methods (Test)
+
+function test_checkRAM(tc)
+import stdlib.sys.checkRAM
+tc.assumeNotEmpty(pyversion)
+
+tc.assertTrue(islogical(checkRAM(1)))
+end
+
+function test_diskfree(tc)
+  import stdlib.sys.diskfree
+tc.assertTrue(isnumeric(diskfree('~')))
+tc.assertTrue(diskfree('~') > 0, 'diskfree')
+end
+
+function test_memory(tc)
+import stdlib.sys.memfree
+tc.assumeNotEmpty(pyversion)
+tc.assertTrue(isnumeric(memfree))
+end
+
+end
+end

+stdlib/+fileio/TestIntg.m

@@ -0,0 +1,30 @@
+function abspath = absolute_path(p)
+% path need not exist, but absolute path is returned
+%
+% NOTE: some network file systems are not resolvable by Matlab Java
+% subsystem, but are sometimes still valid--so return
+% unmodified path if this occurs.
+%
+% Copyright (c) 2020 Michael Hirsch (MIT License)
+arguments
+  p (1,:) string
+end
+
+import stdlib.fileio.expanduser
+import stdlib.fileio.is_absolute_path
+
+% have to expand ~ first
+p = expanduser(p);
+
+if ~is_absolute_path(p)
+  % otherwise the default is Documents/Matlab, which is probably not wanted.
+  p = fullfile(pwd, p);
+end
+
+abspath = p;
+
+for i = 1:length(abspath)
+  abspath(i) = string(java.io.File(abspath(i)).getCanonicalPath());
+end
+
+end % function

+stdlib/+fileio/absolute_path.m

@@ -0,0 +1,22 @@
+function copyfile(in, out)
+%% copyfile(path) overloads copyfile with tilde expansion
+% "out" may be a directory or directory/name.ext
+arguments
+  in (1,1) string
+  out (1,1) string
+end
+
+import stdlib.fileio.expanduser
+
+in = expanduser(in);
+out = expanduser(out);
+
+try
+  copyfile(in, out);
+catch e
+  if e.identifier ~= "MATLAB:COPYFILE:SourceAndDestinationSame"
+    rethrow(e)
+  end
+end
+
+end % function

+stdlib/+fileio/copyfile.m

@@ -0,0 +1,29 @@
+; example.ini -- INI file example for the class INiConfig
+; UPD: 21.03.2010
+
+; Supported whitespaces in section names
+[Section 1]                 ; allowed the comment to section
+key11=10                    ; numeric scalar
+key12=1.45, 19.5, 0.6, -1.4 ; numeric vector
+key13=1.5+3i, -2-2i         ; complex numeric vector
+key14=Hello, Matlab!        ; string
+
+[Section 2]
+; Description of key 1
+key21=3, 5, -1, 2+3i        ; real and complex numeric vector
+
+; Description of key 2
+key23=                      ; empty value
+
+[Section 3]                 ; this empty section
+
+; Sect
+[DATA]
+; Supported whitespaces in key names
+key num = 113               ; supported whitespaces before and after "=" delimiter
+key str = INI file example
+
+[12345]
+01=1, 2, 3, 4, 5
+02=1 2 3 4 5                ; supported whitespace delimiter without comma
+key.01=2.45e-005            ; %e format

+stdlib/+fileio/example.ini

@@ -0,0 +1,34 @@
+function extract_zstd(archive, out_dir)
+% extract a zstd file "archive" to "out_dir"
+% out_dir need not exist yet, but its parent must
+% we do this in two steps to be reliable with old tar versions
+% https://www.scivision.dev/tar-extract-zstd
+
+arguments
+  archive (1,1) string
+  out_dir (1,1) string
+end
+
+archive = stdlib.fileio.expanduser(archive);
+
+assert(isfile(archive), "%s is not a file", archive)
+
+[ret, ~] = system("zstd -h");
+if ret ~= 0
+  if ismac
+    msg = "brew install zstd";
+  else
+    msg = "cmake -P cmake/build_zstd.cmake";
+  end
+  error("need to have Zstd installed: \n install zstd by: \n %s", msg)
+end
+
+tar_arc = tempname;
+
+ret = system("zstd -d " + archive + " -o " + tar_arc);
+assert(ret == 0, "problem extracting %s", archive)
+
+untar(tar_arc, out_dir)
+delete(tar_arc)
+
+end