EXM-49360: Insert the prolog only when schema allows

Author: DunaMariusCosmin

src/main/java/com/oxygenxml/prolog/updater/dita/editor/DitaTopicAuthorEditor.java

@@ -177,11 +177,9 @@ private void addProlog(boolean isNewDocument) throws AuthorOperationException {
 		      );
 
 		  if (prologXpath != null) {
+		    // EXM-49360: Insert only when a valid xpath was found using schema
 		    AuthorPageDocumentUtil.insertFragmentSchemaAware(page, documentController, prologFragment, prologXpath,
 		        AuthorConstants.POSITION_AFTER);
-		  } else {
-		    AuthorPageDocumentUtil.insertFragmentSchemaAware(page, documentController, prologFragment,
-		        ElementXPathUtils.getRootXpath(documentType), AuthorConstants.POSITION_INSIDE_FIRST);
 		  }
 		}
 	}

src/main/java/com/oxygenxml/prolog/updater/dita/editor/DitaTopicTextEditor.java

@@ -119,13 +119,10 @@ private void addProlog(boolean isNewDocument) throws TextOperationException {
 				ElementXPathUtils.getRootXpath(documentType));
 
 		if (xp != null) {
-			TextPageDocumentUtil.insertXmlFragment(wsTextEditorPage,
+		  // EXM-49360: Insert only when a valid xpath was found using schema
+		  TextPageDocumentUtil.insertXmlFragment(wsTextEditorPage,
 					prologCreator.getPrologFragment(isNewDocument, documentType), xp,
 					RelativeInsertPosition.INSERT_LOCATION_AFTER);
-		} else {
-			TextPageDocumentUtil.insertXmlFragment(wsTextEditorPage,
-					prologCreator.getPrologFragment(isNewDocument, documentType), ElementXPathUtils.getRootXpath(documentType),
-					RelativeInsertPosition.INSERT_LOCATION_AS_FIRST_CHILD);
 		}
 	}
 

src/test/java/com/oxygenxml/prolog/updater/AuthorTestCase.java

@@ -81,7 +81,31 @@ private static void initializeCatalogs() throws IOException {
 	 */
 	protected void testInAuthorMode(String inputXML, boolean isNewDocument, String expectedXML)
 			throws IOException, SAXException, BadLocationException, ParserConfigurationException, TransformerException {
-		initializeCatalogs();
+		String toXML = updateProlog(inputXML, isNewDocument);
+
+		String expected = XmlPrettyPrinterUtil.indent(expectedXML).replaceAll(" +", " ");
+		String actual = XmlPrettyPrinterUtil.indent(toXML).replaceAll(" +", " ");
+
+		expected = expected.replaceAll(" <", "<");
+		actual = actual.replaceAll(" <", "<");
+
+		expected = expected.replaceAll("> ", ">");
+		actual = actual.replaceAll("> ", ">");
+
+		assertEquals("The updated content is wrong", expected, actual);
+	}
+
+	/**
+	 * Update the prolog into the given input xml.
+	 * 
+   * @param inputXML The input xml content to update.
+   * @param isNewDocument <code>true</code> if document is new, <code>false</code> otherwise
+	 * 
+	 * @return The updated xml content.
+	 */
+  public String updateProlog(String inputXML, boolean isNewDocument)
+      throws IOException, SAXException, BadLocationException {
+    initializeCatalogs();
 
 		//
 		// Create a AuthorDocumentController
@@ -133,18 +157,8 @@ protected int getMaxNoOfRevisedElements() {
 		AuthorDocument documentNode = controller.getAuthorDocumentNode();
 		AuthorDocumentFragment fragment = controller.createDocumentFragment(documentNode, true);
 		String toXML = controller.serializeFragmentToXML(fragment);
-
-		String expected = XmlPrettyPrinterUtil.indent(expectedXML).replaceAll(" +", " ");
-		String actual = XmlPrettyPrinterUtil.indent(toXML).replaceAll(" +", " ");
-
-		expected = expected.replaceAll(" <", "<");
-		actual = actual.replaceAll(" <", "<");
-
-		expected = expected.replaceAll("> ", ">");
-		actual = actual.replaceAll("> ", ">");
-
-		assertEquals("The updated content is wrong", expected, actual);
-	}
+    return toXML;
+  }
 
 	/**
 	 * Get the date format for TCs

src/test/java/com/oxygenxml/prolog/updater/DitaTopicUpdaterAuthorTest.java

@@ -222,5 +222,47 @@ public void testSaveTwice() throws Exception {
 
   }
 
+  /**
+   * <p><b>Description:</b>Test that resusable files are not updated.</p>
+   * <p><b>Bug ID:</b> EXM-49360</p>
+   *
+   * @author cosmin_duna
+   */
+  public void testReusableFileAreNotUpdated() throws IOException, SAXException, BadLocationException, ParserConfigurationException, TransformerException {
+  	String xml ="<?xml version='1.0' encoding='UTF-8'?>\n" + 
+  	    "<!DOCTYPE oXygen:ReusableComponent [\n" + 
+  	    "<!ELEMENT oXygen:ReusableComponent (oXygen:ComponentDescription, oXygen:ComponentDefinition)>\n" + 
+  	    "<!ATTLIST oXygen:ReusableComponent \n" + 
+  	    "    xmlns:oXygen CDATA #FIXED \"http://www.oxygenxml.com/ns/dita/reuse\" \n" + 
+  	    "    id CDATA #IMPLIED\n" + 
+  	    "    xml:lang CDATA #IMPLIED\n" + 
+  	    "    domains CDATA \"(topic abbrev-d)                            a(props deliveryTarget)                            (topic equation-d)                            (topic hazard-d)                            (topic hi-d)                            (topic indexing-d)                            (topic markup-d)                            (topic mathml-d)                            (topic pr-d)                            (topic relmgmt-d)                            (topic sw-d)                            (topic svg-d)                            (topic ui-d)                            (topic ut-d)                            (topic markup-d xml-d)    (topic oXygen-reuse-d) \"\n" + 
+  	    "    class CDATA \"- topic/topic oXygen:ReusableComponent/oXygen:ReusableComponent \"    \n" + 
+  	    "    xmlns:ditaarch CDATA #FIXED \"http://dita.oasis-open.org/architecture/2005/\"\n" + 
+  	    "    ditaarch:DITAArchVersion CDATA #FIXED \"1.2\" \n" + 
+  	    "    >\n" + 
+  	    "<!ELEMENT oXygen:ComponentDescription (#PCDATA)>\n" + 
+  	    "<!ATTLIST oXygen:ComponentDescription \n" + 
+  	    " class CDATA \"- topic/title oXygen:ReusableComponent/oXygen:ComponentDescription \">\n" + 
+  	    "<!ELEMENT oXygen:ComponentDefinition ANY>\n" + 
+  	    "<!ATTLIST oXygen:ComponentDefinition\n" + 
+  	    "    class CDATA \"- topic/body oXygen:ReusableComponent/oXygen:ComponentDefinition \">\n" + 
+  	    "\n" + 
+  	    "<!ENTITY % dtd PUBLIC \"-//OASIS//DTD DITA Topic//EN\" \"topic.dtd\">\n" + 
+  	    "%dtd;\n" + 
+  	    "\n" + 
+  	    "]>\n" + 
+  	    "<oXygen:ReusableComponent id=\"ReusableComponent_ucc_kgx_xrb\">\n" + 
+  	    "    <oXygen:ComponentDescription></oXygen:ComponentDescription>\n" + 
+  	    "    <oXygen:ComponentDefinition>\n" + 
+  	    "        <p id=\"p_wcc_kgx_xrb\">Most of the information was taken from <xref\n" + 
+  	    "                href=\"http://www.wikipedia.com\" format=\"html\" scope=\"external\">Wikipedia</xref>, the\n" + 
+  	    "            free encyclopedia.</p></oXygen:ComponentDefinition>\n" + 
+  	    "</oXygen:ReusableComponent>\n" + 
+  	    "";
+  	
+  	String contentAfterUpdate = updateProlog(xml, true);
+  	assertFalse(contentAfterUpdate.contains("prolog"));
+  }
 
 }