Merge remote-tracking branch 'origin/AlyxPanelURLChange' into dev

Author: k1o0

+eui/AlyxPanel.m

@@ -59,20 +59,20 @@
     end
 
     methods
-        function obj = AlyxPanel(parent, active)
+        function obj = AlyxPanel(parent, url)
             % Constructor to build all the UI elements and set callbacks to
             % the relevant functions.  If a handle to parant UI object is
             % not specified, a seperate figure is created.  An optional
             % handle to a logging display panal may be provided, otherwise
-            % one is created. If the active flag is set to false, the panel
-            % is inactive and the instance of Alyx will be set to headless.
-            % The panel defaults to active only if the databaseURL field is
-            % populated in the paths.
+            % one is created. The panel will be rendered inactive and the
+            % instance of Alyx will be set to headless if an empty database
+            % URL is provided, or if no URL is provided and the databaseURL
+            % field is not populated in the paths.
             %
             % See also Alyx
-            
+            noParent = ~nargin || isempty(parent);
             obj.AlyxInstance = Alyx('','');
-            if ~nargin % No parant object: create new figure
+            if noParent % No parant object: create new figure
                 f = figure('Name', 'alyx GUI',...
                     'MenuBar', 'none',...
                     'Toolbar', 'none',...
@@ -91,15 +91,18 @@
                 % be set by any other GUI that instantiates this object (e.g.
                 % MControl using this as a panel.
                 obj.NewExpSubject.addlistener('SelectionChanged', @(src, evt)obj.dispWaterReq(src, evt));
+            else
+              % We'll need the figure handle for adding a context menu
+              f = ancestor(parent, 'Figure');
             end
 
             % Check to see if there is a remote database url defined in
             % the paths, if so activate AlyxPanel
             if nargin < 2
               url = char(getOr(dat.paths, 'databaseURL', ''));
-              active = ~isempty(url);
             end
 
+            obj.AlyxInstance.BaseURL = url;
             obj.RootContainer = uix.Panel('Parent', parent, 'Title', 'Alyx');
             alyxbox = uiextras.VBox('Parent', obj.RootContainer);
 
@@ -114,8 +117,8 @@
                 'Callback', @(~,~)obj.login);
             loginbox.Widths = [-1 75];
 
-            % If active flag set as false, make Alyx headless
-            if ~active
+            % If URL is empty, make Alyx headless
+            if isempty(url)
                 obj.AlyxInstance.Headless = true;
                 set(obj.LoginButton, 'Enable', 'off')
             end
@@ -195,7 +198,7 @@
                 'Enable', 'off',...
                 'Callback', @(~,~)obj.launchSessionURL);
 
-            if ~nargin
+            if noParent
                 % logging message area
                 obj.LoggingDisplay = uicontrol('Parent', parent, 'Style', 'listbox',...
                     'Enable', 'inactive', 'String', {});
@@ -204,6 +207,12 @@
                 % Use parent's logging display
                 obj.LoggingDisplay = findobj('Tag', 'Logging Display');
             end
+            obj.log('using database %s', obj.AlyxInstance.BaseURL)
+            % Add context menu for changing database
+            c = uicontextmenu(f);
+            obj.RootContainer.UIContextMenu = c;
+            uimenu(c, 'Label', 'Change database URL', ...
+              'MenuSelectedFcn', @(~,~)obj.changeURL());
         end
 
         function delete(obj)
@@ -301,6 +310,25 @@ function login(obj, varargin)
             obj.dispWaterReq()
         end
 
+        function changeURL(obj, url)
+            % Sets the database URL of the AlyxInstance.  When called with
+            % no inputs, the user is prompted to type in a new URL.  If
+            % logged in, the current token is deleted before changing URL
+            % (unless the new URL is identical).
+            current = obj.AlyxInstance.BaseURL;
+            if nargin == 1 % Prompt user for input
+              prompt = sprintf(['Please enter a database URL to connect to.\n'...
+                'This will log you out of the current database.\n']);
+              url = newid(prompt,'Database URL', [1 50], {current});
+            end
+            % Return if user pressed 'Close' or 'x', or url unchanged
+            if isempty(url) || strcmpi(url, current), return, end
+            % Clear current token, if there is one
+            if obj.AlyxInstance.IsLoggedIn, obj.login; end
+            obj.AlyxInstance.BaseURL = url; % Change URL
+            obj.log('using database %s', obj.AlyxInstance.BaseURL)
+        end
+        
         function giveWater(obj)
             % Callback to the give water button.  Posts the value entered
             % in the text box as either liquid or gel depending on the

docs/scripts/paths_conflicts.m

@@ -79,7 +79,7 @@
 % Another way to avoid these conflicts occuring over time is to reset your
 % paths each time MATLAB starts up.  You can do this by adding the
 % following to <https://uk.mathworks.com/help/matlab/ref/startup.html
-% MATLAB's startup script>:
+% MATLAB's startup script> (make sure the path locations are correct):
 
 disp 'Resetting paths...'
 restoredefaultpath % Restore all paths to factory state
@@ -91,6 +91,7 @@
 % Change these paths to your install locations
 rigbox_path = fullfile(userDir, 'Github', 'rigbox');
 ptb_path = fullfile(userDir, 'PTB', 'Psychtoolbox');
+add_ons = genpath(fullfile(userDir, 'MATLAB', 'Add-Ons'));
 
 % Add Psychtoolbox paths
 disp '...'
@@ -105,6 +106,9 @@
 cd(rigbox_path)
 addRigboxPaths('Strict', false)
 
+% Add Add-Ons folder
+addpath(add_ons)
+
 % Return to default working directory
 cd(userpath)
 clear variables
@@ -113,6 +117,6 @@
 %% Etc.
 % Author: Miles Wells
 %
-% v1.0.0
+% v1.0.1
 %
 % <index.html Home> > <./troubleshooting.html Troubleshooting> > Paths Conflicts

docs/scripts/release_notes_v260.m

@@ -76,6 +76,8 @@
 % * |git.listVersions| - Lists the previous versions of Rigbox availiable 
 % * |git.switchVersion| - Allows you to switched between Rigbox versions
 % * |git.repoVersion| - Returns release tag of repository, if available
+% * |eui.AlyxPanel| - The database URL can now be set via a UI context menu
+% or by passing a URL to the constructor.
 % * |eui.SignalsTest| - Warning instead of error when no stereo output
 % device found
 %
@@ -256,6 +258,7 @@
 % *Tests*
 %
 % * block2Alf - Full test coverage
+% * Explicit test for correct base session creation
 
 %% wheelAnalysis
 %

tests/AlyxPanel_test.m

@@ -38,7 +38,7 @@
   methods (TestClassSetup)
     function killFigures(testCase)
       testCase.FigureVisibleDefault = get(0,'DefaultFigureVisible');
-      set(0,'DefaultFigureVisible','off');
+      set(0,'DefaultFigureVisible', 'off');
     end
 
     function loadData(testCase)
@@ -405,7 +405,6 @@ function test_updateWeightButton(testCase)
     end
 
     function test_giveWater(testCase)
-      testCase.Panel;
       % Tolerance for water verifications, required due to rounding
       tol2dp = 0.01; % rounding to 2 d.p.
       tol1dp = 0.1; % rounding to 1 d.p.
@@ -463,6 +462,51 @@ function test_giveWater(testCase)
       end
     end
 
+    function test_changeURL(testCase)
+      % We only need to test with one URL
+      if ~strcmp(testCase.Panel.AlyxInstance.BaseURL, testCase.BaseURL{1})
+        disp('Skipping test')
+        return
+      end
+      
+      % Test changing URL through method call (assumes we're logged in)
+      url = 'db.example.com';
+      testCase.Panel.changeURL(url);
+      actual = testCase.Panel.AlyxInstance.BaseURL;
+      testCase.verifyMatches(actual, url, 'failed to set database url')
+      
+      % Check new URL printed to log
+      logPanel = findobj(testCase.hPanel, 'Tag', 'Logging Display');
+      testCase.verifyMatches(logPanel.String{end}, url, 'failed to log new url')
+      
+      % Should now be logged out
+      testCase.verifyFalse(testCase.Panel.AlyxInstance.IsLoggedIn)
+      
+      % Now test uimenu callback and prompt
+      testCase.Mock.InTest = true;
+      testCase.Mock.UseDefaults = false;
+
+      % Find Change URL child menu
+      button = testCase.Parent.UIContextMenu.Children(1);
+      testCase.assertTrue(numel(button) == 1, 'UI menu not found');
+      
+      responses = {testCase.BaseURL{1}, testCase.BaseURL{1}}; % Call twice
+      testCase.Mock.Dialogs('Database URL') = fun.CellSeq.create(responses);
+
+      % Run uimenu callback
+      button.MenuSelectedFcn()
+      actual = testCase.Panel.AlyxInstance.BaseURL;
+      expected = testCase.BaseURL{1};
+      testCase.verifyMatches(actual, expected, 'failed to set database url')
+      testCase.verifyMatches(logPanel.String{end}, expected, 'failed to log new url')
+      
+      % When calling again with the same input we expect the function to
+      % return without changing or logging anything
+      nLogs = length(logPanel.String);
+      button.MenuSelectedFcn()
+      testCase.verifyEqual(length(logPanel.String), nLogs, 'unexpected update to log')
+    end
+    
     function test_giveFutureWater(testCase)
       subject = 'ZM_335';
       testCase.SubjectUI.Selected = subject;