Merge pull request #166 from ImperialCollegeLondon/fix/toolbox

fix: Packaged toolbox should contain missing resources files

Author: mfacchinelli

resources/mpackage.json

@@ -1,6 +1,6 @@
 {
     "name": "MAGDataVisualization",
-    "version": "8.0.0",
+    "version": "8.0.1",
     "id": "69962df8-e93e-47cd-a1d6-766ad3e9da8a",
     "formerNames": [],
     "displayName": "MAG Data Visualization",

resources/release-notes.md

@@ -1,17 +1,3 @@
-## App
-
-- (All) Add shortcut to open app from toolbar (quick access)
-- (All) Fix errors when closing app during mission selection
-- (IMAP) Replace `error` with `uialert` for CPT view when mode or range patterns are incorrect
-
-## Software
-
-- (All) Add `mag.mixin.TimeSeriesOperationSupport` for simplified operations support
-- (All) Fix issues with colors and legends for multiple stackedplots
-- (IMAP) Fix cropping of events when no events are loaded
-- (IMAP) Check there is data before enabling auto-compression event in `mag.imap.view.Field`
-
 ## Package
 
-- Add MATLAB package definition
-- Remove MATLAB project definition
+- Add missing files (MATLAB extensions and related icons)

src/utility/+mag/+buildtool/+task/PackageTask.m

@@ -1,6 +1,10 @@
 classdef (Sealed) PackageTask < matlab.buildtool.Task
 % PACKAGETASK Package code into toolbox.
 
+    properties (Constant)
+        ToolboxName (1, 1) string = mag.internal.getPackageDetails("DisplayName")
+    end
+
     properties (Constant, Access = private)
         ToolboxUUID (1, 1) string = "69962df8-e93e-47cd-a1d6-766ad3e9da8a"
     end
@@ -49,10 +53,10 @@ function packageToolbox(task, ~, version)
             end
 
             toolboxOptions = matlab.addons.toolbox.ToolboxOptions(task.PackageRoot, task.ToolboxUUID, ...
-                ToolboxName = "MAG Data Visualization", ...
+                ToolboxName = task.ToolboxName, ...
                 ToolboxVersion = version, ...
-                Description = "Source code for MAG Data Visualization toolbox.", ...
-                ToolboxFiles = fullfile(task.PackageRoot, ["app", "src"]), ...
+                Description = mag.internal.getPackageDetails("Description"), ...
+                ToolboxFiles = task.getToolboxFiles(), ...
                 ToolboxMatlabPath = task.getMATLABPath(), ...
                 ToolboxImageFile = fullfile(task.PackageRoot, "icons", "logo.png"), ...
                 OutputFile = task.ToolboxPath, ...
@@ -67,13 +71,23 @@ function packageToolbox(task, ~, version)
         end
     end
 
+    methods (Access = private)
+
+        function files = getToolboxFiles(task)
+
+            files = fullfile(task.PackageRoot, ["app", "src", ...
+                fullfile("resources", "extensions.json"), ...
+                fullfile("icons", "mag.png")]);
+        end
+    end
+
     methods (Static, Access = private)
 
         function matlabPath = getMATLABPath()
 
             matlabPath = string(split(path(), pathsep()));
 
-            locMAG = contains(matlabPath, "MAG-Data-Visualization") & contains(matlabPath, ["app", "src"]);
+            locMAG = contains(matlabPath, "MAG-Data-Visualization") & ~contains(matlabPath, "tests");
             matlabPath = matlabPath(locMAG);
         end
     end

src/utility/+mag/+internal/getPackageDetails.m

@@ -0,0 +1,19 @@
+function details = getPackageDetails(fieldName)
+% GETPACKAGEDETAILS Load MATLAB package details from manifest.
+
+    arguments (Input)
+        fieldName string {mustBeScalarOrEmpty, mustBeNonzeroLengthText} = string.empty()
+    end
+
+    root = fullfile(fileparts(mfilename("fullpath")), "../../../../");
+    details = readstruct(fullfile(root, "resources", "mpackage.json"));
+
+    if ~isempty(fieldName)
+
+        % If the first letter is capitalized (for compatibility with
+        % "matlab.mpm.Package" properties), make it lowercase.
+        fieldName = regexprep(fieldName, "(\w)(\w+)", "${lower($1)}$2");
+
+        details = details.(fieldName);
+    end
+end

src/utility/+mag/version.m

@@ -9,19 +9,7 @@
     persistent ver;
 
     if isempty(ver)
-
-        location = fileparts(mfilename("fullpath"));
-        root = fullfile(location, "../../../");
-
-        if isMATLABReleaseOlderThan("R2025a")
-
-            package = readstruct(fullfile(root, "resources", "mpackage.json"));
-            ver = package.version;
-        else
-
-            package = matlab.mpm.Package(root);
-            ver = package.Version;
-        end
+        ver = mag.internal.getPackageDetails("Version");
     end
 
     v = ver;

tests/system/package/tToolbox.m

@@ -14,6 +14,15 @@
         function useMATLABR2025aOrAbove(testCase)
             testCase.assumeFalse(isMATLABReleaseOlderThan("R2025a"), "Only MATLAB R2025a or later is supported for this test.");
         end
+
+        function checkMATLABPackage(testCase)
+
+            % MATLAB will still execute this method, even if the above
+            % check fails.
+            if ~isMATLABReleaseOlderThan("R2025a")
+                testCase.assumeEmpty(mpmlist(mag.buildtool.task.PackageTask.ToolboxName), "MAG Data Visualization installed as a MATLAB package.");
+            end
+        end
     end
 
     methods (Test)
@@ -46,10 +55,10 @@ function installToolbox(testCase)
             testCase.assertTrue(isfile(task.ToolboxArtifact.Path), "Toolbox should be generated.");
 
             matlab.addons.install(task.ToolboxArtifact.Path);
-            testCase.addTeardown(@() matlab.addons.uninstall("MAG Data Visualization"));
+            testCase.addTeardown(@() matlab.addons.uninstall(mag.buildtool.task.PackageTask.ToolboxName));
 
             addOns = matlab.addons.installedAddons();
-            locMAG = addOns.Name == "MAG Data Visualization";
+            locMAG = addOns.Name == mag.internal.getPackageDetails("DisplayName");
 
             testCase.verifyEqual(addOns{locMAG, "Version"}, mag.version(), "Toolbox version should be equal to MAG version.");
         end