refactor set defaults

Author: Remi-Gau

src/utils/setDefaults.m

@@ -0,0 +1,41 @@
+function structure = setDefaults(structure, fieldsToSet)
+    % structure = setDefaults(structure, fieldsToSet)
+    %
+    % recursively loop through the fields of a structure and sets a value if they don't exist
+    %
+
+    fieldsToSet = orderfields(fieldsToSet);
+
+    names = fieldnames(fieldsToSet);
+
+    for i = 1:numel(names)
+
+        thisField = fieldsToSet.(names{i});
+
+        if isfield(structure, names{i}) && isstruct(structure.(names{i}))
+
+            structure.(names{i}) = ...
+                setDefaults(...
+                structure.(names{i}), ...
+                fieldsToSet.(names{i})...
+                );
+
+        else
+
+            structure = setFieldToIfNotPresent( ...
+                structure, ...
+                names{i}, ...
+                thisField);
+        end
+
+    end
+
+    structure = orderfields(structure);
+
+end
+
+function structure = setFieldToIfNotPresent(structure, fieldName, value)
+    if ~isfield(structure, fieldName)
+        structure.(fieldName) = value;
+    end
+end

src/utils/setDefaultsPTB.m

@@ -84,45 +84,3 @@
     cfg = orderfields(cfg);
 
 end
-
-function structure = setDefaults(structure, fieldsToSet)
-    % structure = setDefaultFields(structure, fieldsToSet)
-    %
-    % recursively loop through the fields of a structure and sets a value if they don't exist
-    %
-
-    fieldsToSet = orderfields(fieldsToSet);
-
-    names = fieldnames(fieldsToSet);
-
-    for i = 1:numel(names)
-
-        thisField = fieldsToSet.(names{i});
-
-        if isfield(structure, names{i}) && isstruct(structure.(names{i}))
-
-            structure.(names{i}) = ...
-                setDefaults(...
-                structure.(names{i}), ...
-                fieldsToSet.(names{i})...
-                );
-
-        else
-
-            structure = setFieldToIfNotPresent( ...
-                structure, ...
-                names{i}, ...
-                thisField);
-        end
-
-    end
-
-    structure = orderfields(structure);
-
-end
-
-function structure = setFieldToIfNotPresent(structure, fieldName, value)
-    if ~isfield(structure, fieldName)
-        structure.(fieldName) = value;
-    end
-end

tests/test_setDefaults.m

@@ -0,0 +1,43 @@
+function test_suite = test_setDefaults %#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_setDefaultsWrite()
+
+    %% set up
+    structure = struct();
+
+    fieldsToSet.field = 1;
+
+    structure = setDefaults(structure, fieldsToSet);
+
+    %% data to test against
+    expectedStructure.field = 1;
+
+    %% test
+    assertEqual(expectedStructure, structure);
+
+end
+
+function test_setDefaultsNoOverwrite()
+
+    % set up
+    structure.field.subfield_1 = 3;
+
+    fieldsToSet.field.subfield_1 = 1;
+    fieldsToSet.field.subfield_2 = 1;
+
+    structure = setDefaults(structure, fieldsToSet);
+
+    % data to test against
+    expectedStructure.field.subfield_1 = 3;
+    expectedStructure.field.subfield_2 = 1;
+
+    % test
+    assert(isequal(expectedStructure, structure));
+
+end