fix: missing attributes (childQuestionnaireRef & lastUpdatedDate)

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>fr.insee.pogues</groupId>
 	<artifactId>pogues-model</artifactId>
-	<version>1.4.1</version>
+	<version>1.4.2-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<name>Pogues Model</name>

src/main/java/fr/insee/pogues/conversion/JSONDeserializer.java

@@ -20,7 +20,7 @@ public class JSONDeserializer {
 
 	private static final Logger logger = LoggerFactory.getLogger(JSONDeserializer.class);
 
-	public Questionnaire deserialize(String fileName) throws JAXBException, IOException {
+	public Questionnaire deserializeFile(String fileName) throws JAXBException, IOException {
 
 		if (fileName == null || fileName.isEmpty()) {
 			// TODO: throwing an exception instead of silent failing would be better here
@@ -52,6 +52,12 @@ public Questionnaire deserialize(InputStream jsonQuestionnaireInputStream) throw
 		return deserializeStreamSource(preProcessedStream);
 	}
 
+	public Questionnaire deserialize(String json) throws JAXBException {
+		logger.debug("Deserializing json questionnaire from input stream.");
+		StreamSource preProcessedStream = new StreamSource(new StringReader(json));
+		return deserializeStreamSource(preProcessedStream);
+	}
+
 	private static Questionnaire deserializeStreamSource(StreamSource json) throws JAXBException {
 
 		JAXBContext context = JAXBContext.newInstance(Questionnaire.class);

src/main/resources/xsd/Questionnaire.xsd

@@ -95,6 +95,11 @@
                 </xs:sequence>
               </xs:complexType>
             </xs:element>
+            <xs:element name="childQuestionnaireRef" type="xs:string" minOccurs="0" maxOccurs="unbounded">
+              <xs:annotation>
+                <xs:documentation>childQuestionnaireRef currently contains the ids of references of questionnaires that the questionnaire depends.</xs:documentation>
+              </xs:annotation>
+            </xs:element>
           </xs:sequence>
           <xs:attribute name="agency" type="xs:token" default="com.example">
             <xs:annotation>
@@ -122,6 +127,11 @@
                 entire questionnaire, the mix of languages is not supported. </xs:documentation>
             </xs:annotation>
           </xs:attribute>
+          <xs:attribute name="lastUpdatedDate" type="xs:string">
+            <xs:annotation>
+              <xs:documentation>lastUpdatedDate represents the date on which the questionnaire was last saved.</xs:documentation>
+            </xs:annotation>
+          </xs:attribute>
         </xs:extension>
       </xs:complexContent>
     </xs:complexType>

src/test/java/fr/insee/pogues/test/JSONDeserializerTest.java

@@ -2,18 +2,40 @@
 
 import fr.insee.pogues.conversion.JSONDeserializer;
 import fr.insee.pogues.model.Questionnaire;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 import javax.xml.bind.JAXBException;
 import java.io.IOException;
+import java.util.Arrays;
 
 import static org.junit.jupiter.api.Assertions.*;
 
 class JSONDeserializerTest {
 
+
+	private String jsonLastUpdatedDate;
+	private String jsonChildQuestionnaireRef;
+
+	@BeforeEach
+	void setup() {
+		jsonLastUpdatedDate = """
+                {
+                  "id": "questionnaire-id",
+                  "lastUpdatedDate": "Tue Dec 10 2024 10:33:38 GMT+0100 (heure normale d’Europe centrale)"
+                }
+                """;
+		jsonChildQuestionnaireRef = """
+                {
+                  "id": "questionnaire-id",
+                  "childQuestionnaireRef": [ "ref-id-1", "ref-id-2" ]
+                }
+                """;
+	}
+
 	@Test // Note: this test should be replaced by an exception test, see comment in deserializer class.
-	void deserializeFromNullInput_resultShouldBeNull() throws JAXBException, IOException {
-		assertNull(new JSONDeserializer().deserialize((String) null));
+	void deserializeFileFromNullInput_resultShouldBeNull() throws JAXBException, IOException {
+		assertNull(new JSONDeserializer().deserializeFile(null));
 	}
 
 	@Test
@@ -22,7 +44,7 @@ void testQuestionnaire() throws Exception {
 		long startTime = System.currentTimeMillis();
 
 		JSONDeserializer deserializer = new JSONDeserializer();
-		Questionnaire questionnaire = deserializer.deserialize("src/main/resources/examples/fr.insee-POPO-QPO-DOC.json");
+		Questionnaire questionnaire = deserializer.deserializeFile("src/main/resources/examples/fr.insee-POPO-QPO-DOC.json");
 
 		long elapsedTime = System.currentTimeMillis() - startTime;
 
@@ -31,4 +53,18 @@ void testQuestionnaire() throws Exception {
 		assertNotNull(questionnaire);
 	}
 
+	@Test
+	void testLastUpdatedDate() throws Exception {
+		JSONDeserializer deserializer = new JSONDeserializer();
+		Questionnaire questionnaire = deserializer.deserialize(jsonLastUpdatedDate);
+		assertEquals("Tue Dec 10 2024 10:33:38 GMT+0100 (heure normale d’Europe centrale)", questionnaire.getLastUpdatedDate());
+	}
+
+	@Test
+	void testChildQuestionnaireRef() throws Exception {
+		JSONDeserializer deserializer = new JSONDeserializer();
+		Questionnaire questionnaire = deserializer.deserialize(jsonChildQuestionnaireRef);
+		assertEquals(Arrays.asList("ref-id-1", "ref-id-2"), questionnaire.getChildQuestionnaireRef());
+	}
+
 }

src/test/java/fr/insee/pogues/test/XMLSerializerTest.java

@@ -120,4 +120,40 @@ void serializeCodeList() throws JAXBException, UnsupportedEncodingException, JSO
 		XmlAssert.assertThat(result).and(expectedXml).ignoreWhitespace().areIdentical();
 	}
 
+
+	@Test
+	void serializeLastUpdated() throws JAXBException, UnsupportedEncodingException, JSONException {
+		// Given
+		Questionnaire questionnaire = new Questionnaire();
+		questionnaire.setLastUpdatedDate("fake-date");
+		// When
+		XMLSerializer xmlSerializer = new XMLSerializer();
+		String result = xmlSerializer.serialize(questionnaire);
+		// Then
+		String expectedXml = """
+				<?xml version="1.0" encoding="UTF-8"?>
+				<Questionnaire xmlns="http://xml.insee.fr/schema/applis/pogues" lastUpdatedDate="fake-date"/>
+				""";
+		XmlAssert.assertThat(result).and(expectedXml).ignoreWhitespace().areIdentical();
+	}
+
+	@Test
+	void serializeChildQuestionnaireRef() throws JAXBException, UnsupportedEncodingException, JSONException {
+		// Given
+		Questionnaire questionnaire = new Questionnaire();
+		questionnaire.getChildQuestionnaireRef().add("id-ref-1");
+		questionnaire.getChildQuestionnaireRef().add("id-ref-2");
+		// When
+		XMLSerializer xmlSerializer = new XMLSerializer();
+		String result = xmlSerializer.serialize(questionnaire);
+		// Then
+		String expectedXml = """
+				<?xml version="1.0" encoding="UTF-8"?>
+				<Questionnaire xmlns="http://xml.insee.fr/schema/applis/pogues">
+					<childQuestionnaireRef>id-ref-1</childQuestionnaireRef>
+					<childQuestionnaireRef>id-ref-2</childQuestionnaireRef>
+				</Questionnaire>
+				""";
+		XmlAssert.assertThat(result).and(expectedXml).ignoreWhitespace().areIdentical();
+	}
 }

src/test/java/fr/insee/pogues/test/XMLToJSONTranslatorTest.java

@@ -12,6 +12,8 @@
 class XMLToJSONTranslatorTest {
 
     private String xmlCodeList;
+    private String xmlLastUpdatedDate;
+    private String xmlChildQuestionnaireRef;
 
     @BeforeEach
     void setup() {
@@ -28,6 +30,20 @@ void setup() {
                     <Label>CODE_2</Label>
                   </Code>
                 </CodeList>""";
+        xmlLastUpdatedDate = """
+                <Questionnaire 
+                    xmlns="http://xml.insee.fr/schema/applis/pogues"
+                    id="questionnaire-id" 
+                    lastUpdatedDate="Tue Dec 10 2024 10:33:38 GMT+0100 (heure normale d’Europe centrale)"/>
+                """;
+        xmlChildQuestionnaireRef = """
+                <Questionnaire 
+                    xmlns="http://xml.insee.fr/schema/applis/pogues"
+                    id="questionnaire-id">
+                    <childQuestionnaireRef>ref-id-1</childQuestionnaireRef>
+                    <childQuestionnaireRef>ref-id-2</childQuestionnaireRef>
+                </Questionnaire>
+                """;
     }
 
     @Test
@@ -55,4 +71,33 @@ void translateCodeList() throws JAXBException, JSONException {
         JSONAssert.assertEquals(expectedJson, result, JSONCompareMode.STRICT);
     }
 
+    @Test
+    void translateLastUpdatedDate() throws JAXBException, JSONException {
+        //
+        XMLToJSONTranslator xmlToJsonTranslator = new XMLToJSONTranslator();
+        String result = xmlToJsonTranslator.translate(xmlLastUpdatedDate);
+        //
+        String expectedJson = """
+                {
+                  "id": "questionnaire-id",
+                  "lastUpdatedDate": "Tue Dec 10 2024 10:33:38 GMT+0100 (heure normale d’Europe centrale)"
+                }""";
+        JSONAssert.assertEquals(expectedJson, result, JSONCompareMode.STRICT);
+    }
+
+    @Test
+    void translateChildQuestionnaireRef() throws JAXBException, JSONException {
+        //
+        XMLToJSONTranslator xmlToJsonTranslator = new XMLToJSONTranslator();
+        String result = xmlToJsonTranslator.translate(xmlChildQuestionnaireRef);
+        //
+        String expectedJson = """
+                {
+                  "id": "questionnaire-id",
+                  "childQuestionnaireRef": [ "ref-id-1", "ref-id-2" ]
+                }
+                """;
+        JSONAssert.assertEquals(expectedJson, result, JSONCompareMode.STRICT);
+    }
+
 }