Fix: Cache with map of required properties per neurodata type must be version specific (#670)

* Add "version" as property to Namespace class

* Add routine for writing a function for retrieving version of generated namespace

* Regenerate core with version numbers

* Update generateRstForNeurodataTypeClasses.m

Ignore version function when creating list of neurodata types to document

* Add version specificity to cache containing map of required properties

Author: ehennestad

+file/writeNamespace.m

@@ -3,6 +3,7 @@ function writeNamespace(namespaceName, saveDir)
 Namespace = schemes.loadNamespace(namespaceName, saveDir);
 
 classFileDir = fullfile(saveDir, '+types', ['+' misc.str2validName(Namespace.name)]);
+writeNamespaceVersion(classFileDir, Namespace.version)
 
 if ~isfolder(classFileDir)
     mkdir(classFileDir);
@@ -29,4 +30,28 @@ function writeNamespace(namespaceName, saveDir)
         % pass
     end
 end
-end
+end
+
+function writeNamespaceVersion(classFileDir, version)
+% writeNamespaceVersion - Write function for retrieving version of
+% generated namespace.
+    
+    functionTemplate = strjoin([...
+        "function version = %s()", ...
+        "    version = '%s';", ...
+        "end" ...
+    ], newline);
+    
+    functionDefinition = sprintf(functionTemplate, ...
+        matnwb.common.constant.VERSIONFUNCTION, ...
+        version);
+
+    if ~isfolder(classFileDir); mkdir(classFileDir); end  
+    namespaceVersionFilename = fullfile(...
+        classFileDir, ...
+        matnwb.common.constant.VERSIONFILE);
+    
+    fid = fopen(namespaceVersionFilename, 'wt');
+    fwrite(fid, functionDefinition);
+    fclose(fid);
+end

+matnwb/+common/+constant/VERSIONFILE.m

@@ -0,0 +1,3 @@
+function constant = VERSIONFILE()
+    constant = [matnwb.common.constant.VERSIONFUNCTION, '.m'];
+end

+matnwb/+common/+constant/VERSIONFUNCTION.m

@@ -0,0 +1,3 @@
+function constant = VERSIONFUNCTION()
+    constant = 'Version';
+end

+schemes/Namespace.m

@@ -1,6 +1,7 @@
 classdef Namespace < handle
     properties (SetAccess=private)
         name = ''           % name of this namespace
+        version = ''        % version of this namespace
         dependencies = []   % parent namespaces by [Namespace]
         registry = []       % maps name to class
     end
@@ -11,12 +12,13 @@
     end
 
     methods
-        function obj = Namespace(name, deplist, source)
+        function obj = Namespace(name, version, deplist, source)
             if nargin == 0
                 return
             end
 
             obj.name = strrep(name, '-', '_');
+            obj.version = version;
             obj.dependencies = deplist;
             namespaceFiles = keys(source);
             obj.registry = [];

+schemes/loadNamespace.m

@@ -14,5 +14,5 @@
     ancestry(i) = schemes.loadNamespace(ancestorName, saveDir);
 end
 
-Namespace = schemes.Namespace(name, ancestry, Cache.schema);
+Namespace = schemes.Namespace(name, Cache.version, ancestry, Cache.schema);
 end

+types/+core/Version.m

@@ -0,0 +1,3 @@
+function version = Version()
+    version = '2.8.0';
+end

+types/+hdmf_common/Version.m

@@ -0,0 +1,3 @@
+function version = Version()
+    version = '1.8.0';
+end

+types/+hdmf_experimental/Version.m

@@ -0,0 +1,3 @@
+function version = Version()
+    version = '0.5.0';
+end

+types/+untyped/MetaClass.m

@@ -182,7 +182,8 @@ function displayWarningIfMissingRequiredProps(obj)
 
                 propertyListStr = obj.prettyPrintPropertyList(missingRequiredProps);
                 warning('NWB:RequiredPropertyMissing', ...
-                    'The following required properties are missing for instance for type "%s":\n%s', class(obj), propertyListStr)
+                    ['The following required properties are missing for ', ...
+                    'instance for type "%s":\n%s'], class(obj), propertyListStr)
             end
         end
 
@@ -202,7 +203,9 @@ function throwErrorIfMissingRequiredProps(obj, fullpath)
             if ~isempty( missingRequiredProps )
                 propertyListStr = obj.prettyPrintPropertyList(missingRequiredProps);
                 error('NWB:RequiredPropertyMissing', ...
-                    'The following required properties are missing for instance for type "%s" at file location "%s":\n%s', class(obj), fullpath, propertyListStr)
+                    ['The following required properties are missing for ', ...
+                    'instance for type "%s" at file location "%s":\n%s' ], ...
+                    class(obj), fullpath, propertyListStr)
             end
         end
 
@@ -211,7 +214,9 @@ function throwErrorIfCustomConstraintUnfulfilled(obj, fullpath)
                 obj.checkCustomConstraint()
             catch ME
                 error('NWB:CustomConstraintUnfulfilled', ...
-                    'The following error was caught when exporting type "%s" at file location "%s":\n%s', class(obj), fullpath, ME.message)
+                    ['The following error was caught when exporting type ', ...
+                    '"%s" at file location "%s":\n%s'], ...
+                    class(obj), fullpath, ME.message)
             end
         end
     end
@@ -227,16 +232,21 @@ function checkCustomConstraint(obj) %#ok<MANU>
         function requiredProps = getRequiredProperties(obj)
 
             % Introspectively retrieve required properties and add to
-            % persistent map.
+            % persistent cache/map.
 
-            if isKey(obj.REQUIRED, class(obj) )
-                requiredProps = obj.REQUIRED( class(obj) );
+            typeClassName = class(obj);
+            typeNamespaceVersion = getNamespaceVersionForType(typeClassName);
+
+            typeKey = sprintf('%s_%s', typeClassName, typeNamespaceVersion);
+
+            if isKey(obj.REQUIRED, typeKey)
+                requiredProps = obj.REQUIRED( typeKey );
             else
                 mc = metaclass(obj);
                 propertyDescription = {mc.PropertyList.Description};
                 isRequired = startsWith(propertyDescription, 'REQUIRED');
                 requiredProps = {mc.PropertyList(isRequired).Name};
-                obj.REQUIRED( class(obj) ) = requiredProps;
+                obj.REQUIRED( typeKey ) = requiredProps;
             end
         end
 
@@ -262,3 +272,18 @@ function checkCustomConstraint(obj) %#ok<MANU>
         end
     end
 end
+
+function version = getNamespaceVersionForType(typeClassName)
+    if strcmp(typeClassName, 'NwbFile')
+        namespaceName = 'types.core';
+    else
+        classNameParts = strsplit(typeClassName, '.');
+        namespaceName = strjoin(classNameParts(1:end-1), '.');
+    end
+    assert(startsWith(namespaceName, 'types.'), ...
+        'Expected type to belong to namespace.') 
+    
+    version = feval( ...
+        sprintf('%s.%s', namespaceName, matnwb.common.constant.VERSIONFUNCTION) ...
+        );
+end

tools/documentation/private/generateRstForNeurodataTypeClasses.m

@@ -4,10 +4,14 @@ function generateRstForNeurodataTypeClasses(namespaceName)
     arguments
         namespaceName (1,1) string
     end
+
+    filenameToIgnore = {matnwb.common.constant.VERSIONFILE};
+
     namespaceName = char(namespaceName);
 
     rootDir = misc.getMatnwbDir();
     classFiles = dir(fullfile(rootDir, '+types', ['+', namespaceName], '*.m'));
+    classFiles(ismember({classFiles.name}, filenameToIgnore)) = [];
 
     docsSourceRootDir = fullfile(misc.getMatnwbDir, 'docs', 'source');
     exportDir = fullfile(docsSourceRootDir, 'pages', 'neurodata_types', namespaceName);