add tests for user input

Author: Remi-Gau

manualTests/test_userInput.m

@@ -0,0 +1,19 @@
+function cfg = askForGroupAndOrSession(cfg)
+    
+    askGrpSess = [true true];
+    
+    if isfield(cfg, 'subject') && ...
+            isfield(cfg.subject, 'askGrpSess') && ...
+            ~isempty(cfg.subject.askGrpSess)
+
+        askGrpSess = cfg.subject.askGrpSess;
+
+    end
+    
+    if numel(askGrpSess) < 2
+        askGrpSess(2) = 1;
+    end
+    
+    cfg.subject.askGrpSess = askGrpSess;
+    
+end

src/subfun/askForGroupAndOrSession.m

@@ -0,0 +1,34 @@
+function questions = createQuestionList(cfg)
+    
+    cfg = askForGroupAndOrSession(cfg);
+    
+    questions.group = 'Enter subject group (leave empty if none): ';
+    questions.subject = 'Enter subject number (1-999): ';
+    questions.session = 'Enter the session (i.e day - 1-999)) number: ';
+    questions.run = 'Enter the run number (1-999): ';
+    questions.mustBePositiveInteger = 'Please enter a positive integer: ';
+    % questions.questionsToAsk is a cell array : second column is a boolean
+    % set to true if we must run inputCheck on the response
+    questions.questionsToAsk = cell(4,2);
+    
+    % subject group
+    if cfg.subject.askGrpSess(1)
+        questions.questionsToAsk{1, 1} = questions.group;
+        questions.questionsToAsk{1, 2} = false;
+    end
+    
+    % the subject number
+    questions.questionsToAsk{2, 1} = questions.subject;
+    questions.questionsToAsk{2, 2} = true;
+    
+    % the session number
+    if  cfg.subject.askGrpSess(2)
+        questions.questionsToAsk{3, 1} = questions.session;
+        questions.questionsToAsk{3, 2} = true;
+    end
+    
+    % the run number
+    questions.questionsToAsk{4, 1} = questions.run;
+    questions.questionsToAsk{4, 2} = true;
+    
+end

src/subfun/createQuestionList.m

@@ -0,0 +1,9 @@
+function trueOrFalse = isPositiveInteger(input2check)
+    
+    trueOrFalse = ~(...
+        ~isnumeric(input2check) || ...
+        isnan(input2check) || ...
+        fix(input2check) ~= input2check || ...
+        input2check < 0);
+    
+end

src/subfun/isPositiveInteger.m

@@ -9,72 +9,75 @@
     %    - the first value set to false will skip asking for the participants
     %    group
     %    - the second value set to false will skip asking for the session
-
+    
     if nargin < 1
-        cfg = [];
+        cfg = struct('debug', []);
     end
+    
     if isempty(cfg.debug)
         cfg.debug.do = false;
     end
-
-    askGrpSess = [true true];
-    if isfield(cfg, 'subject') && ...
-            isfield(cfg.subject, 'askGrpSess') && ...
-            ~isempty(cfg.subject.askGrpSess)
-
-        askGrpSess = cfg.subject.askGrpSess;
-
-    end
-    if numel(askGrpSess) < 2
-        askGrpSess(2) = 1;
-    end
-
-    subjectGrp = '';
-    subjectNb = []; %#ok<*NASGU>
-    sessionNb = [];
-    runNb = [];
+    
+    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
-        subjectGrp = 'ctrl';
-        subjectNb = 666;
-        runNb = 666;
-        sessionNb = 666;
-
+        
+        responses{1,1} = 'ctrl';
+        responses{2,1} = 666;
+        responses{3,1} = 666;
+        responses{4,1} = 666;
+        
         % Otherwise it prompts the user for some information
     else
 
-        % subject group
-        if askGrpSess(1)
-            subjectGrp = lower(input('Enter subject group (leave empty if none): ', 's'));
-        end
+        questions = createQuestionList(cfg);
+        
+        responses = askUserCli(questions);
+        
+    end
+    
+    cfg.subject.subjectGrp = responses{1,1};
+    cfg.subject.subjectNb = responses{2,1};
+    cfg.subject.sessionNb = responses{3,1};
+    cfg.subject.runNb = responses{4,1};
+    
+end
 
-        % the subject number
-        subjectNb = str2double(input('Enter subject number (1-999): ', 's'));
-        subjectNb = checkInput(subjectNb);
 
-        % the session number
-        if  numel(askGrpSess) > 1 && askGrpSess(2)
-            sessionNb = str2double(input('Enter the session (i.e day - 1-999)) number: ', 's'));
-            sessionNb = checkInput(sessionNb);
+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
-
-        % the run number
-        runNb = str2double(input('Enter the run number (1-999): ', 's'));
-        runNb = checkInput(runNb);
-
+        
     end
-
-    cfg.subject.subjectGrp = subjectGrp;
-    cfg.subject.subjectNb = subjectNb;
-    cfg.subject.sessionNb = sessionNb;
-    cfg.subject.runNb = runNb;
-
+    
 end
 
-function input2check = checkInput(input2check)
+
+function input2check = checkInput(input2check, questions)
     % this function checks the input to makes sure the user enters a positive integer
-    while isnan(input2check) || fix(input2check) ~= input2check || input2check < 0
-        input2check = str2double(input('Please enter a positive integer: ', 's'));
+    
+    while ~isPositiveInteger(input2check)
+        input2check = str2double(input(questions.mustBePositiveInteger, 's'));
     end
+    
 end

src/userInputs.m

@@ -0,0 +1,52 @@
+function test_suite = test_askForGroupAndOrSession %#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_askForGroupAndOrSessionBasic()
+
+    %% set up
+    cfg = struct();
+    cfg = askForGroupAndOrSession(cfg);
+    
+    expectedStructure = struct('subject', struct('askGrpSess', [true true]));
+    
+    assertEqual(expectedStructure, cfg)
+    
+end
+
+function test_askForGroupAndOrSessionNoGroup()
+
+    cfg.subject.askGrpSess = 0;
+    cfg = askForGroupAndOrSession(cfg);
+    
+    expectedStructure = struct('subject', struct('askGrpSess', [false true]));
+    
+    assertEqual(expectedStructure, cfg)
+    
+end
+
+function test_askForGroupAndOrSessionNoGroupNoSession()
+
+    cfg.subject.askGrpSess = [0 0];
+    cfg = askForGroupAndOrSession(cfg);
+    
+    expectedStructure = struct('subject', struct('askGrpSess', [false false]));
+    
+    assertEqual(expectedStructure, cfg)
+    
+end
+
+function test_askForGroupAndOrSessionNoSession()
+
+    cfg.subject.askGrpSess = [1 0];
+    cfg = askForGroupAndOrSession(cfg);
+    
+    expectedStructure = struct('subject', struct('askGrpSess', [true false]));
+    
+    assertEqual(expectedStructure, cfg)
+    
+end

tests/test_askForGroupAndOrSession.m

@@ -0,0 +1,24 @@
+function test_suite = test_createQuestionList %#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_createQuestionListBasic()
+
+    %% set up
+    cfg = struct();
+    
+    questions = createQuestionList(cfg);
+    
+    expectedCell = { ...
+        'Enter subject group (leave empty if none): ', false;
+        'Enter subject number (1-999): ', true;
+        'Enter the session (i.e day - 1-999)) number: ', true;
+        'Enter the run number (1-999): ', true};
+    
+    assertEqual(expectedCell, questions.questionsToAsk)
+    
+end

tests/test_createQuestionList.m

@@ -0,0 +1,17 @@
+function test_suite = test_isPositiveInteger %#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_isPositiveIntegerBasic()
+
+    assertTrue(isPositiveInteger(1));
+    assertFalse(isPositiveInteger(nan()))
+    assertFalse(isPositiveInteger(0.3))
+    assertFalse(isPositiveInteger(-1))
+    assertFalse(isPositiveInteger('1'))
+    
+end