strictdoc-project/reqif

Python library for ReqIF format. ReqIF parsing and unparsing.

reqif's Issues

Align the names of the python in-memory objects to the reqif node names

The first example of this is the ...in the library, this is spec_object instead of spec_object_ref. I may be reading too much into the request from the OP, but this caught me off guard as I'm getting started.

Support tag: <ATTRIBUTE-DEFINITION-STRING>.<DEFAULT-VALUE>

Refactoring needed: Flexible order of printing XML namespace declarations

<REQ-IF xmlns="http://www.omg.org/spec/ReqIF/20110401/reqif.xsd" xmlns:configuration="http://eclipse.org/rmf/pror/toolextensions/1.0" xmlns:id="http://pror.org/presentation/id" xmlns:xhtml="http://www.w3.org/1999/xhtml">

Currently, the order in which the declarations are hardcoded and it is enough to pass all integration test but there surely is a yet another tool that produces them in a different order.

cli: add "version" command, also --version

Edge case: self-closing <OBJECT> tags break the subsequent HTML markup

Validation: Spec Hierarchy must reference an existing Spec Object

Refactoring: unify how original XML meta information is attached to each ReqIF object

Currently, some ReqIF objects store their original LXML tree nodes (xml_nodes) as well as some information regarding the order in which their children tags are printed (children_tags). The solution for each object has evolved into something different every time. Now there should be enough information to create a single abstraction that holds necessary XML metadata.

All APIs: make all optional methods have default arguments

adapt example on PyPi.org

The example code on Pypi.org, handling regifz files isn't working on Python3.10 as the iterator on the dictionary used so far is returning a string.
Please adapt the line
for reqif_bundle in reqifz_bundle.reqif_bundles:

to be
for key in reqifz_bundle.reqif_bundles.keys():

as well as
for attachment in reqifz_bundle.attachments:
to be
for key, attachment in reqifz_bundle.attachments.items():

or similar

XML to ReqIF?

Hi I am quite new to XML and ReqIF. I know that ReqIF is a type of XML file but from what I understand, it is formatted differently. Can XML be converted to this format using the unparser?

Figure out closing / non-closing tags with SPECIFICATION-TYPE

Implement the validation of ReqIF files against the official XSD schema

Recently, I have received a yet another random example from a user who obtained it randomly from the internet.

In that example, there are tags that are not part of the official XSD schema, and I started to wonder if it is a good time to implement an XSD-based validator. Using the official ReqIF XSD file, it should be possible to highlight to the users when they would try to feed non-compliant files to reqif.

I tried to use xmlschema for reading the ReqIF's XSD, but I got an issue that I reported here: sissaschool/xmlschema#360. When that issue is resolved, it is worth to give it another shot because the xmlschema tool looks very promising.

The official ReqIF XSD: https://www.omg.org/spec/ReqIF/20110401/reqif.xsd.

ReqIFParser validation API: at least "Non ReqIF content"

Implement TC1300: RELATION-GROUP-TYPE

Validation: SpecRelation shall link to existing SpecObjects

Real-world example:

        <SPEC-RELATION IDENTIFIER="ADB3C6E4-8014-4167-9D21-A8E13D98C6CA" LAST-CHANGE="2011-06-13T10:24:18+01:00">
          <SOURCE>
            <SPEC-OBJECT-REF>FUNC-REQ-1</SPEC-OBJECT-REF>
          </SOURCE>
          <TARGET>
            <SPEC-OBJECT-REF>FUNC-REQ-2</SPEC-OBJECT-REF>
          </TARGET>
          <TYPE>
            <SPEC-RELATION-TYPE-REF>deriveReq</SPEC-RELATION-TYPE-REF>
          </TYPE>
        </SPEC-RELATION>

FUNC-REQ-1 does not exist anywhere in the document.

Realistic ReqIF examples

To implement a generic support of ReqIF format, it would be nice to have simple samples produced by the ReqIF tools as follows:

• A sample of a one empty document.
• A sample of three empty documents.
• A sample of one document with one requirement.
• A sample of one document with several requirements.
• A sample of one document having 3 chapters, each having 2 requirements.
• A sample of one document having 3 requirements that reference each other via a parent link: C -> B, B -> A.
• A sample of a document having tables and figures (if applicable).

---

Find enough realistic ReqIF examples produced by ReqIF tools:

• org.eclipse.rmf file1 org.eclipse.rmf file2
• Enterprise Architect 8.0 example
• Multiple examples at ci.eclipse.org/rmf. They are referred to by the RD02.
• ReqIF Studio Example contributed by a user
• Rational DOORS
• Rational DOORS (second example)
• Polarion
• ReqView
• PTC Integrity
• NoMagic MagicDraw

ReqIFParser.parse cannot parse reqifz files

@stanislaw , would you be open to a PR that would allow to parse reqifz (arhived ReqIF) files?

Currently, the lib can only parse flat .reqif files.

Double-check and complete all the type information in the function signatures

Minor issue: dump_xml_node() adds "xmlns:html" to the output

<SPEC-HIERARCHY xmlns:xhtml="http://www.w3.org/1999/xhtml" IDENTIFIER="_B92p0WunEeuNUYnTveUm8Q" LAST-CHANGE="2021-02-11T10:31:27.215+01:00">

It should be possible to deactivate this default behavior of lxml.

Rewrite the anonymise command using pure lxml

Backlog: Minimal HTML browser for debugging purposes

Validation: Spec Object shall have valid schema types

Make it very obvious how to retrieve the requirement text

I'm still not sure how to do this, and will continue to read through the examples and unit tests. It's not clear how to navigate from a SPEC-OBJECT-REF to the SPEC-OBJECT with the same identifier to retrieve the LONG-NAME or THE-VALUE. Even once I can retrieve THE-VALUE, most of it is in XHTML, whereas I want plain text.

Possible issue with escaping XHTML content

<                   <xhtml:p style=" font-style: italic">Delay <xhtml:span style="text-decoration: underline;">&lt;= 5s</xhtml:span></xhtml:p>
---
>                   <xhtml:p style=" font-style: italic">Delay <xhtml:span style="text-decoration: underline;"><= 5s</xhtml:span></xhtml:p>

Validation: SpecRelation has to have SOURCE and TARGET tags

As specified in Figure 10.6 - Requirements, requirement relations and how requirements are structured hierarchically in a specification.

ReqIFParser API: add a method to parse from string directly, not from a file.

Backlog: Support the Doors extension: READONLY-ATTRIBUTES

The sample provided in #150 contains this extension's fragment.