refactor saveEvents before adding more tests

Author: Remi-Gau

src/saveEventsFile.m

@@ -285,7 +285,7 @@ function printHeaderExtraColumns(logFile)
                                          namesExtraColumns{iExtraColumn});
 
             end
-            warningSaveEventsFile(cfg, 'missingData', warningMessage);
+            throwWarning(cfg, 'saveEventsFile:missingData', warningMessage);
 
             if cfg.verbose > 1
                 disp(logFile(iEvent));
@@ -297,50 +297,6 @@ function printHeaderExtraColumns(logFile)
 
 end
 
-function data = checkInput(data)
-    % check the data to write
-    % default will be 'n/a' for chars and NaN for numeric data
-    % for numeric data that don't have the expected length, it will be padded with NaNs
-    if islogical(data) && data
-        data = 'true';
-    elseif islogical(data) && ~data
-        data = 'false';
-    end
-
-    if ischar(data) && isempty(data) || strcmp(data, ' ')
-        data = 'n/a';
-    elseif isempty(data)
-        % important to not set this to n/a as we still need to check if this
-        % numeric valur has the right length and needs to be nan padded
-        data = nan;
-    end
-
-end
-
-function data = nanPadding(cfg, data, expectedLength)
-
-    if nargin < 2
-        expectedLength = [];
-    end
-
-    if ~isempty(expectedLength) && isnumeric(data)
-
-        if max(size(data)) < expectedLength
-            padding = expectedLength - max(size(data));
-            data(end + 1:end + padding) = nan(1, padding);
-
-        elseif max(size(data)) > expectedLength
-            warningMessage = ['A field for this event is longer than expected.', ...
-                              'Truncating extra values.'];
-            warningSaveEventsFile(cfg, 'arrayTooLong', warningMessage);
-
-            data = data(1:expectedLength);
-
-        end
-    end
-
-end
-
 function logFile = saveToLogFile(logFile, cfg)
 
     % appends to the logfile all the data stored in the structure
@@ -367,7 +323,7 @@ function printHeaderExtraColumns(logFile)
 
                 skipEvent = true;
 
-                warningMessageID = 'emptyEvent';
+                warningMessageID = 'saveEventsFile:emptyEvent';
                 warningMessage = sprintf(['Skipping saving this event. \n '...
                                           'onset: %s \n duration: %s \n'], ...
                                          onset, ...
@@ -391,21 +347,21 @@ function printHeaderExtraColumns(logFile)
             if all(~isValid)
                 skipEvent = true;
 
-                warningMessageID = 'emptyEvent';
+                warningMessageID = 'saveEventsFile:emptyEvent';
                 warningMessage = sprintf(['Skipping saving this event. \n', ...
                                           'No values defined. \n']);
 
             elseif any(~isValid)
                 skipEvent = false;
 
-                warningMessageID = 'missingData';
+                warningMessageID = 'saveEventsFile:missingData';
                 warningMessage = sprintf('Missing some %s data for this event. \n', ...
                                          namesExtraColumns{find(isValid)});
             end
         end
 
         % now save the event to log file (if not skipping)
-        warningSaveEventsFile(cfg, warningMessageID, warningMessage);
+        throwWarning(cfg, warningMessageID, warningMessage);
 
         printToFile(cfg, logFile, skipEvent, iEvent);
 
@@ -504,14 +460,3 @@ function errorSaveEventsFile(identifier)
     error(errorStruct);
 
 end
-
-function warningSaveEventsFile(cfg, identifier, warningMessage)
-    if cfg.verbose > 0 && ...
-            nargin == 3 && ...
-            ~isempty(identifier) && ...
-            ~isempty(warningMessage)
-
-        warningMessageID = ['saveEventsFile:' identifier];
-        warning(warningMessageID, warningMessage);
-    end
-end

src/utils/checkInput.m

@@ -0,0 +1,28 @@
+% (C) Copyright 2020 CPP_BIDS developers
+
+function data = checkInput(data)
+    %
+    % Check the data to write and convert to the proper format if needed.
+    %
+    % Default will be 'n/a' for chars and NaN for numeric data.
+    %
+    % USAGE::
+    %
+    %   data = checkInput(data)
+    %
+
+    if islogical(data) && data
+        data = 'true';
+    elseif islogical(data) && ~data
+        data = 'false';
+    end
+
+    if ischar(data) && isempty(data) || strcmp(data, ' ')
+        data = 'n/a';
+    elseif isempty(data)
+        % Important to not set this to n/a as we might still need to check if this
+        % numeric value has the right length and needs to be nan padded
+        data = nan;
+    end
+
+end

src/utils/nanPadding.m

@@ -0,0 +1,28 @@
+% (C) Copyright 2020 CPP_BIDS developers
+
+function data = nanPadding(cfg, data, expectedLength)
+
+    % For numeric data that don't have the expected length, it will be padded
+    % with NaNs. If the vector is too long it will be truncated
+
+    if nargin < 2
+        expectedLength = [];
+    end
+
+    if ~isempty(expectedLength) && isnumeric(data)
+
+        if max(size(data)) < expectedLength
+            padding = expectedLength - max(size(data));
+            data(end + 1:end + padding) = nan(1, padding);
+
+        elseif max(size(data)) > expectedLength
+            warningMessage = ['A field for this event is longer than expected.', ...
+                              'Truncating extra values.'];
+            throwWarning(cfg, 'nanPadding:arrayTooLong', warningMessage);
+
+            data = data(1:expectedLength);
+
+        end
+    end
+
+end

src/utils/throwWarning.m

@@ -0,0 +1,11 @@
+% (C) Copyright 2020 CPP_BIDS developers
+
+function throwWarning(cfg, identifier, warningMessage)
+    if cfg.verbose > 0 && ...
+            nargin == 3 && ...
+            ~isempty(identifier) && ...
+            ~isempty(warningMessage)
+
+        warning(identifier, warningMessage);
+    end
+end

tests/test_saveEventsFileSave.m

@@ -165,7 +165,7 @@ function test_saveEventsFileSaveArraySize()
     logFile(end, 1).duration = 3;
     logFile(end, 1).LHL24 = rand(1, 15);
 
-    assertWarning(@()saveEventsFile('save', cfg, logFile), 'saveEventsFile:arrayTooLong');
+    assertWarning(@()saveEventsFile('save', cfg, logFile), 'nanPadding:arrayTooLong');
 
     saveEventsFile('save', cfg, logFile);