Merge pull request #118 from mathworks/116-baseapp-changes-to-varargin-and-preferences-handling-fail-to-support-subclass-property-value-pairs

rjackey · web-flow · commit c8f09644a52c · 2025-03-24T16:46:48.000-04:00
116 baseapp changes to varargin and preferences handling fail to support subclass property value pairs
diff --git a/resources/project/-Rt430bOCzwOXXnyFuW3kh29Cd8/ewqdM3i8oNdTvIHzy2yj-dSsqrQd.xml b/resources/project/-Rt430bOCzwOXXnyFuW3kh29Cd8/ewqdM3i8oNdTvIHzy2yj-dSsqrQd.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="design"/>
+    </Category>
+</Info>
diff --git a/resources/project/-Rt430bOCzwOXXnyFuW3kh29Cd8/ewqdM3i8oNdTvIHzy2yj-dSsqrQp.xml b/resources/project/-Rt430bOCzwOXXnyFuW3kh29Cd8/ewqdM3i8oNdTvIHzy2yj-dSsqrQp.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="BaseAppSubclassWithPrefs.m" type="File"/>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/rgXXnynq22bfGDhCOgy-Zy3ZN2wd.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/rgXXnynq22bfGDhCOgy-Zy3ZN2wd.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info/>
diff --git a/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/rgXXnynq22bfGDhCOgy-Zy3ZN2wp.xml b/resources/project/Xc4-tOl6vkwzCeVKSWRahPrXJiQ/rgXXnynq22bfGDhCOgy-Zy3ZN2wp.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="+model" type="File"/>
diff --git a/resources/project/rgXXnynq22bfGDhCOgy-Zy3ZN2w/pGDZdQSspps9j-AHHEl8xpwB9_wd.xml b/resources/project/rgXXnynq22bfGDhCOgy-Zy3ZN2w/pGDZdQSspps9j-AHHEl8xpwB9_wd.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info>
+    <Category UUID="FileClassCategory">
+        <Label UUID="design"/>
+    </Category>
+</Info>
diff --git a/resources/project/rgXXnynq22bfGDhCOgy-Zy3ZN2w/pGDZdQSspps9j-AHHEl8xpwB9_wp.xml b/resources/project/rgXXnynq22bfGDhCOgy-Zy3ZN2w/pGDZdQSspps9j-AHHEl8xpwB9_wp.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="CustomPreferenceForTest.m" type="File"/>
diff --git a/resources/project/rgXXnynq22bfGDhCOgy-Zy3ZN2w/qI-uCTiQlNgHwweeJG4tsCJWqHYd.xml b/resources/project/rgXXnynq22bfGDhCOgy-Zy3ZN2w/qI-uCTiQlNgHwweeJG4tsCJWqHYd.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info/>
diff --git a/resources/project/rgXXnynq22bfGDhCOgy-Zy3ZN2w/qI-uCTiQlNgHwweeJG4tsCJWqHYp.xml b/resources/project/rgXXnynq22bfGDhCOgy-Zy3ZN2w/qI-uCTiQlNgHwweeJG4tsCJWqHYp.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="1" type="DIR_SIGNIFIER"/>
diff --git a/test/+wt/+test/+apps/BaseAppSubclassWithPrefs.m b/test/+wt/+test/+apps/BaseAppSubclassWithPrefs.m
@@ -0,0 +1,74 @@
+classdef BaseAppSubclassWithPrefs < wt.apps.BaseApp
+    % Test app utilizing the BaseApp subclass
+    %   Copyright 2025 The MathWorks Inc.
+
+    %% Properties
+    properties (AbortSet)
+
+        % Name of the app
+        PropertyA (1,1) double = 10
+
+    end %properties
+
+
+    %% Constructor / destructor
+    methods (Access = public)
+
+        function app = BaseAppSubclassWithPrefs(varargin)
+            % Constructor
+
+            % Custom preferences
+            prefs = wt.test.model.CustomPreferenceForTest();
+            prefGroup = "wtTemporaryPreferenceGroup";
+
+            % Call the superclass constructor with custom prefs
+            app@wt.apps.BaseApp(...
+                "PreferenceGroup",prefGroup,...
+                "Preferences",prefs,...
+                varargin{:});
+
+        end %methods
+
+    end %function
+
+
+    %% Internal Properties
+    properties (Hidden, SetAccess = private)
+
+        % Label
+        Label matlab.ui.control.Label
+
+        EditField matlab.ui.control.NumericEditField
+
+    end %properties
+
+
+    %% Protectected Methods
+    methods (Access = protected)
+
+        function setup(app)
+
+            % Create a label in the grid
+            app.Label = uilabel(app.Grid);
+            app.Label.HorizontalAlignment = "center";
+            app.Label.VerticalAlignment = "center";
+            app.Label.FontSize = 24;
+            app.Label.Text = "Test App - setup";
+
+            % Create a label in the grid
+            app.EditField = uieditfield(app.Grid,'numeric');
+            app.EditField.FontSize = 24;
+
+        end %function
+
+
+        function update(app)
+
+            app.Label.Text = "Text App - update";
+            app.EditField.Value = app.PropertyA;
+
+        end %function
+
+    end %methods
+
+end %classdef
diff --git a/test/+wt/+test/+model/CustomPreferenceForTest.m b/test/+wt/+test/+model/CustomPreferenceForTest.m
@@ -0,0 +1,15 @@
+classdef CustomPreferenceForTest < wt.model.Preferences
+    % Example subclassed preferences for unit testing
+
+    %   Copyright 2025 The MathWorks Inc.
+
+
+    %% Preference Properties
+    properties (AbortSet)
+
+        % Starting window position
+        TestPreferenceA (1,1) double = 17
+
+    end %properties
+
+end %classdef
diff --git a/test/+wt/+test/BaseApp.m b/test/+wt/+test/BaseApp.m
@@ -77,6 +77,96 @@ function testBaseAppBasicCase(testCase)
 
         end %function
 
+
+        function testCustomPreferenceApp(testCase)
+            % Verifies behavior of the app with subclass preferences
+ 
+            % Launch the app
+            diag = "Expected BaseAppSubclassWithPrefs to launch without warnings.";
+            fcn = @()wt.test.apps.BaseAppSubclassWithPrefs();
+            testCase.App = testCase.verifyWarningFree(fcn, diag);
+
+            % Verify app and component creation
+            diag = "Expected BaseAppSubclassWithPrefs figure to be populated.";
+            testCase.verifyNotEmpty(testCase.App.Figure, diag)
+
+            diag = "Expected BaseAppSubclassWithPrefs internal Label to be populated.";
+            testCase.verifyNotEmpty(testCase.App.Label, diag)
+
+            % Verify update was run
+            diag = "Expected app's label to have changed in the update method.";
+            expVal = "Text App - update";
+            actVal = testCase.App.Label.Text;
+            testCase.verifyMatches(actVal, expVal, diag);
+
+            % Verify preferences
+            diag = "Expected app's preferences to be wt.test.model.CustomPreferenceForTest.";
+            actVal = testCase.App.Preferences;
+            expClass = "wt.test.model.CustomPreferenceForTest";
+            testCase.verifyInstanceOf(actVal, expClass, diag);
+
+            % Verify app closes
+            diag = "Expected app to close without warnings.";
+            fcn = @()close(testCase.App);
+            testCase.verifyWarningFree(fcn, diag);
+
+            diag = "Expected app to be deleted.";
+            testCase.verifyFalse(isvalid(testCase.App), diag)
+
+        end %function
+
+
+        function testCustomPreferencesAndInputArgsApp(testCase)
+            % Verifies behavior of the app with custom preferences and custom input arguments
+
+            % Launch the app with input args
+            propAInputValue = randi(1000); % random integer
+            diag = "Expected BaseAppSubclassWithPrefs to launch without warnings.";
+            fcn = @()wt.test.apps.BaseAppSubclassWithPrefs("PropertyA", propAInputValue);
+            testCase.App = testCase.verifyWarningFree(fcn, diag);
+
+            % Verify app and component creation
+            diag = "Expected BaseAppSubclassWithPrefs figure to be populated.";
+            testCase.verifyNotEmpty(testCase.App.Figure, diag)
+
+            diag = "Expected BaseAppSubclassWithPrefs internal Label to be populated.";
+            testCase.verifyNotEmpty(testCase.App.Label, diag)
+
+            % Verify update was run
+            diag = "Expected app's label to have changed in the update method.";
+            expVal = "Text App - update";
+            actVal = testCase.App.Label.Text;
+            testCase.verifyMatches(actVal, expVal, diag);
+
+            % Verify property was set
+            diag = "Expected PropertyA to have been set to input argument value.";
+            expVal = propAInputValue;
+            actVal = testCase.App.PropertyA;
+            testCase.verifyEqual(actVal, expVal, diag)
+
+            % Verify property set occurred before update
+            % Edit field should show correct value
+            diag = "Expected edit field to display the PropertyA's input argument.";
+            expVal = propAInputValue;
+            actVal = testCase.App.EditField.Value;
+            testCase.verifyEqual(actVal, expVal, diag)
+
+            % Verify preferences
+            diag = "Expected app's preferences to be wt.test.model.CustomPreferenceForTest.";
+            actVal = testCase.App.Preferences;
+            expClass = "wt.test.model.CustomPreferenceForTest";
+            testCase.verifyInstanceOf(actVal, expClass, diag);
+
+            % Verify app closes
+            diag = "Expected app to close without warnings.";
+            fcn = @()close(testCase.App);
+            testCase.verifyWarningFree(fcn, diag);
+
+            diag = "Expected app to be deleted.";
+            testCase.verifyFalse(isvalid(testCase.App), diag)
+
+        end %function
+
     end %methods
 
 end %classdef
diff --git a/widgets/+wt/+apps/BaseApp.m b/widgets/+wt/+apps/BaseApp.m
@@ -151,20 +151,8 @@ function forceUpdate(app)
     %% Constructor / destructor
     methods (Access = public)
 
-        function app = BaseApp(options)
+        function app = BaseApp(varargin)
             % Constructor
-
-            arguments
-                options.?wt.apps.BaseApp
-                options.Preferences (1,1) wt.model.Preferences = wt.model.Preferences;
-                options.PreferenceGroup (1,1) string = "";
-            end
-
-            % Check for preference input and assign it first, in case
-            % Preferences was subclassed
-            app.Preferences = options.Preferences;
-            app.PreferenceGroup = options.PreferenceGroup;
-            options = rmfield(options, ["Preferences" "PreferenceGroup"]);
             
             % Create the figure and hide until components are created
             app.Figure = uifigure( ...
@@ -179,11 +167,13 @@ function forceUpdate(app)
             app.Grid.Padding = [0 0 0 0];
 
             % Check for preference input and assign it first, in case
-            % Preferences was subclassed
-            % [splitArgs,varargin] = app.splitArgs('Preferences', varargin{:});
-            % if ~isempty(splitArgs)
-            %     app.Preferences = splitArgs{2};
-            % end
+            % Preferences was subclassed. Can also set Visible here if
+            % desired to do earlier.
+            [prefArgs, remArgs] = app.splitArgs(...
+                ["Visible", "PreferenceGroup", "Preferences"], varargin{:});
+            if ~isempty(prefArgs)
+                set(app, prefArgs{:});
+            end
 
             % Retrieve preferences
             app.loadPreferences();
@@ -202,9 +192,8 @@ function forceUpdate(app)
             app.setup();
 
             % Set any P-V pairs
-            cellArgs = namedargs2cell(options);
-            if ~isempty(cellArgs)
-                set(app, cellArgs{:});
+            if ~isempty(remArgs)
+                set(app, remArgs{:});
             end
 
             % Show output if Debug is on
@@ -225,15 +214,11 @@ function forceUpdate(app)
             % Update the title
             app.updateTitle();
 
-            % Force drawing to finish
+            % Force drawing to finish now
             drawnow('limitrate')
 
             % Now, make it visible
-            if isfield(options, 'Visible')
-                app.Figure.Visible = options.Visible;
-            else
             app.Figure.Visible = 'on';
-            end
 
         end %function
 
@@ -553,6 +538,34 @@ function updateTitle(app)
     end %methods
 
 
+    %% Private methods
+    methods (Access = private)
+        
+        function  [splitArgs, remArgs] = splitArgs(~,argnames,varargin)
+            % Separate specified P-V arguments from the rest of P-V pairs
+            
+            narginchk(1,inf) ;
+            splitArgs = {};
+            remArgs = {};
+            
+            if nargin>1
+                props = cellstr( varargin(1:2:end) );
+                values = varargin(2:2:end);
+                if ( numel( props ) ~= numel( values ) ) || ...
+                        any( ~cellfun( @(x)ischar(x)||isStringScalar(x), props ) )
+                    error( 'wt:baseApp:splitArgs:BadSyntax', ...
+                        'Arguments must be supplied as property-value pairs' );
+                end
+                ToSplit = ismember(props,argnames);
+                ToSplit = reshape([ToSplit; ToSplit],1,[]);
+                splitArgs = varargin(ToSplit);
+                remArgs = varargin(~ToSplit);
+            end
+            
+        end %function
+
+    end %methods
+
 
     %% Display Customization
     methods (Access = protected)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version="1.0" encoding="UTF-8"?>`
	`2`	`+<Info location="BaseAppSubclassWithPrefs.m" type="File"/>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version="1.0" encoding="UTF-8"?>`
	`2`	`+<Info/>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version="1.0" encoding="UTF-8"?>`
	`2`	`+<Info location="+model" type="File"/>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version="1.0" encoding="UTF-8"?>`
	`2`	`+<Info location="CustomPreferenceForTest.m" type="File"/>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version="1.0" encoding="UTF-8"?>`
	`2`	`+<Info location="1" type="DIR_SIGNIFIER"/>`