[Fix] read THE-ORIGINAL-VALUE of XHTML attribute values; fixes #95

[samatstariongroup]

Prerequisites

• I have written a descriptive pull-request title
• I have verified that there are no overlapping pull-requests open
• I have verified that I am following the ReqIFSharp code style guidelines
• I have provided test coverage for my change (where applicable)

Description

Fixes #95.

AttributeValueXHTML.ReadXml and ReadXmlAsync never read THE-ORIGINAL-VALUE, although WriteXml writes it. TheOriginalValue was always null after reading, so a document that was read and written again lost the original values of its simplified XHTML attribute values. ReqIF 1.2 (10.8.20 and Clause 8) needs that value so that a later tool in the exchange chain can restore the original.

Changes (AttributeValueXHTML.cs)

• The read loop now handles only the direct children of ATTRIBUTE-VALUE-XHTML: DEFINITION, THE-VALUE and THE-ORIGINAL-VALUE, in any order, as the schema's xsd:all allows. THE-ORIGINAL-VALUE is read like THE-VALUE (inner XML, trimmed).
• ReadInnerXml and Skip already move the reader to the next node, so the loop does not call Read() after them. Adding THE-ORIGINAL-VALUE to the old loop would have lost it in minified documents when it follows THE-VALUE (the problem fixed in [Bug]: Elements are skipped when a ReqIF document has no whitespace between elements #94).
• ATTRIBUTE-DEFINITION-XHTML-REF is read through a subtree of DEFINITION, where the schema puts it. An unknown reference still throws InvalidOperationException.
• Any other child is skipped, with its content.

Tests

• New AttributeValueXHTMLReadTestFixture:
  • the six original values in reqifsharpgenerated.reqif are read, and each is marked as simplified;
  • read, write and read again keeps TheOriginalValue and IsSimplified;
  • four orders of the three children, and two orders with an unknown child (which contains a THE-VALUE and a DEFINITION that must not be read), each read correctly, indented and minified, .reqif and .reqifz, sync and async. THE-VALUE and THE-ORIGINAL-VALUE get distinct content, so a mix-up is caught;
  • an unknown definition reference throws.
• AttributeValueXHTMLTestFixture: ReadXmlAsync throws OperationCanceledException for a cancelled token.
• The minify helper moved from MinifiedDocumentTestFixture into TestDocuments, and keeps whitespace inside THE-ORIGINAL-VALUE. The existing graph comparisons now include the original values.
• Each new test fails when the code it covers is broken: the old reader fails all of them, and the old loop with THE-ORIGINAL-VALUE added fails the minified orders.
• dotnet build -c Release: 0 warnings; dotnet test: 448 passed.

Found during this work and tracked separately:

• [Bug]: Elements are matched on local name only, so elements in another namespace are read as ReqIF elements #97: elements are matched on local name only, across the library.
• [Bug]: The public constructors of AttributeValueXHTML leave ExternalObjects or the logger null #98: the public constructors of AttributeValueXHTML leave ExternalObjects or the logger null.

🤖 Generated with Claude Code

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
4 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud