refactor and add more tests

Author: Remi-Gau

src/subfun/askUserCli.m

@@ -0,0 +1,34 @@
+function responses = askUserCli(questions, responses)
+    % response = askUserCli(questions)
+    %
+    % command line interface to ask questions to user
+    %
+    
+    for iQuestion = 1:size(questions.questionsToAsk, 1)
+        
+        if ~isempty(questions.questionsToAsk{iQuestion,1})
+            
+            thisResponse = ...
+                input(['\n' questions.questionsToAsk{iQuestion,1}], 's'); %#ok<*AGROW>
+            
+            if questions.questionsToAsk{iQuestion,2}
+                thisResponse = str2double(thisResponse);
+                thisResponse = checkInput(thisResponse, questions);
+            end
+            
+            responses{iQuestion, 1} = thisResponse;
+            
+        end
+        
+    end
+    
+end
+
+function input2check = checkInput(input2check, questions)
+    % this function checks the input to makes sure the user enters a positive integer
+    
+    while ~isPositiveInteger(input2check)
+        input2check = str2double(input(questions.mustBePositiveInteger, 's'));
+    end
+    
+end

src/subfun/setDefaultResponses.m

@@ -0,0 +1,25 @@
+function [cfg, responses] = setDefaultResponses(cfg)
+    
+    if nargin < 1
+        cfg = struct('debug', []);
+    end
+    
+    if isempty(cfg.debug)
+        cfg.debug.do = false;
+    end
+    
+    responses{1,1} = ''; % subjectGrp
+    responses{2,1} = []; % subjectNb
+    responses{3,1} = 1; % runNb
+    responses{4,1} = []; % sessionNb
+    
+    if cfg.debug.do
+        
+        responses{1,1} = 'ctrl';
+        responses{2,1} = 666;
+        responses{3,1} = 666;
+        responses{4,1} = 666;
+        
+    end
+    
+end

src/userInputs.m

@@ -14,29 +14,13 @@
         cfg = struct('debug', []);
     end
 
-    if isempty(cfg.debug)
-        cfg.debug.do = false;
-    end
+    [cfg, responses] = setDefaultResponses(cfg);
 
-    responses{1,1} = ''; % subjectGrp
-    responses{2,1} = []; % subjectNb
-    responses{3,1} = 1; % runNb
-    responses{4,1} = []; % sessionNb
-
-    % When in debug more this function returns some dummy values
-    if cfg.debug.do
-        
-        responses{1,1} = 'ctrl';
-        responses{2,1} = 666;
-        responses{3,1} = 666;
-        responses{4,1} = 666;
+    if ~cfg.debug.do
 
-        % Otherwise it prompts the user for some information
-    else
-
         questions = createQuestionList(cfg);
 
-        responses = askUserCli(questions);
+        responses = askUserCli(questions, responses);
 
     end
 
@@ -45,39 +29,4 @@
     cfg.subject.sessionNb = responses{3,1};
     cfg.subject.runNb = responses{4,1};
 
-end
-
-
-function responses = askUserCli(questions)
-    % response = askUserCli(questions)
-    %
-    % command line interface to ask questions to user
-    %
-    
-    for iQuestion = 1:size(questions.questionsToAsk, 1)
-        
-        if ~isempty(questions.questionsToAsk{iQuestion,1})
-            
-            responses{iQuestion, 1} = ...
-                input(questions.questionsToAsk{iQuestion,1}, 's'); %#ok<*AGROW>
-            
-            if questions.questionsToAsk{iQuestion,2}
-                responses{iQuestion, 1} = str2double(responses);
-                responses{iQuestion, 1} = checkInput(responses, questions);
-            end
-            
-        end
-        
-    end
-    
-end
-
-
-function input2check = checkInput(input2check, questions)
-    % this function checks the input to makes sure the user enters a positive integer
-    
-    while ~isPositiveInteger(input2check)
-        input2check = str2double(input(questions.mustBePositiveInteger, 's'));
-    end
-    
-end
+end

tests/test_setDefaultResponses.m

@@ -0,0 +1,32 @@
+function test_suite = test_setDefaultResponses %#ok<*STOUT>
+    try % assignment of 'localfunctions' is necessary in Matlab >= 2016
+        test_functions = localfunctions(); %#ok<*NASGU>
+    catch % no problem; early Matlab versions can use initTestSuite fine
+    end
+    initTestSuite;
+end
+
+function test_setDefaultResponsesBasic()
+
+    %%
+    [~, responses] = setDefaultResponses(); %#ok<*NODEF>
+    
+    expectedCell{1,1} = '';
+    expectedCell{2,1} = [];
+    expectedCell{3,1} = 1;
+    expectedCell{4,1} = [];
+    
+    assertEqual(expectedCell, responses)
+    
+    %%
+    cfg.debug.do = true;
+    [~, responses] = setDefaultResponses(cfg);
+    
+    expectedCell{1,1} = 'ctrl';
+    expectedCell{2,1} = 666;
+    expectedCell{3,1} = 666;
+    expectedCell{4,1} = 666;
+    
+    assertEqual(expectedCell, responses)
+    
+end