Merge pull request #374 from datajoint/stage2

Add support for curly brackets in commments

Author: guzman-raphael

+dj/+internal/Declare.m

@@ -382,7 +382,7 @@ case regexp(line, ['^[a-z][a-z\d_]*\s*' ...       % name
                 end
             end
             % Escape characters: "/
-            field.comment = regexprep(field.comment, '(["\/])', '\\\\$1');
+            field.comment = regexprep(field.comment, '(["\/{}])', '\\\\$1');
 
             category = dj.internal.Declare.matchType(field.type);
             store = [];

+dj/setup.m

@@ -23,7 +23,7 @@ function setup(varargin)
         struct(...
             'Name', 'mym', ...
             'ResolveTarget', 'datajoint/mym', ...
-            'Version', @(v) compareVersions(v, '2.8.0', @(v_actual,v_ref) v_actual>=v_ref)...
+            'Version', @(v) compareVersions(v, '2.8.2', @(v_actual,v_ref) v_actual>=v_ref)...
         )...
     };
     try

+dj/version.m

@@ -1,7 +1,7 @@
 function varargout = version
 % report DataJoint version
 
-v = struct('major',3,'minor',4,'bugfix',2);
+v = struct('major',3,'minor',4,'bugfix',3);
 
 if nargout
     varargout{1}=v;

LNX-docker-compose.yaml

@@ -29,7 +29,7 @@ services:
       interval: 1s
   fakeservices.datajoint.io:
     <<: *net
-    image: datajoint/nginx:v0.0.15
+    image: datajoint/nginx:v0.0.16
     environment:
     - ADD_db_TYPE=DATABASE
     - ADD_db_ENDPOINT=db:3306

docs-parts/intro/Releases_lang1.rst

@@ -1,3 +1,7 @@
+3.4.3 -- May 28, 2021
+---------------------
+* Bugfix: Add support to curly brackets in comments (#365) PR #373 
+
 3.4.2 -- March 16, 2021
 --------------------------
 * Bugfix: Fetchn with zero results throws an error (#353) PR #355

local-docker-compose.yaml

@@ -34,7 +34,7 @@ services:
       interval: 1s
   fakeservices.datajoint.io:
     <<: *net
-    image: raphaelguzman/nginx:v0.0.11
+    image: datajoint/nginx:v0.0.16
     environment:
     - ADD_db_TYPE=DATABASE
     - ADD_db_ENDPOINT=db:3306

tests/Main.m

@@ -1,6 +1,7 @@
 classdef Main < ...
     TestConfig & ...
     TestConnection & ...
+    TestDeclaration & ...
     TestERD & ...
     TestExternalFile & ...
     TestExternalS3 & ...
@@ -11,4 +12,4 @@
     TestSchema & ...
     TestTls & ...
     TestUuid
-end
+end

tests/TestDeclaration.m

@@ -0,0 +1,31 @@
+classdef TestDeclaration < Prep
+    methods (Test)
+        %{ Function to test if a table can be inserted with curley brackets in the comments
+        %}
+        function TestDeclaration_testCurlyBracketComment(testCase)
+            packageName = 'Lab';
+            lowerPackageName = lower(packageName);
+            % Create the connection
+            c1 = dj.conn(...
+                testCase.CONN_INFO.host,... 
+                testCase.CONN_INFO.user,...
+                testCase.CONN_INFO.password, '', true);
+
+            % Create the schema
+            dj.createSchema(packageName, [testCase.test_root '/test_schemas'], ...
+                [testCase.PREFIX '_' lowerPackageName]);
+
+            % Initialize the table
+            Lab.Subject
+
+            % Check that the comment is correct
+            table = Lab.Subject();
+            firstAttributeComment = table.header.attributes.comment;
+            assert(strcmp( ...
+                firstAttributeComment, ...
+                '{subject_id} Comment to test curly bracket'), ...
+                'Comment did not get inserted correctly'...
+                );
+        end
+    end
+end

tests/TestSchema.m

@@ -37,7 +37,7 @@ function TestSchema_testUnsupportedDJTypes(testCase)
                 [testCase.PREFIX '_' lower(package)]);
             schema = External.getSchema;
             q = schema.v.Document & ['document_id=' num2str(id)];
-            % display
+            % display (be careful with MxPrint's b/c this test relies on stdout)
             queryPreview = evalc('q');
             queryPreview = splitlines(queryPreview);
             recordPreview = queryPreview(end-4);

tests/test_schemas/+Lab/Subject.m

@@ -1,6 +1,6 @@
 %{
 # Subject
-subject_id : int   
+subject_id : int  # {subject_id} Comment to test curly bracket
 ---
 subject_dob : date
 unique index(subject_dob)