Feature Discussion: hash based review of external reference content

[ckolumbus]

Hi *, i'd like to get some feedback on a feature idea I have

Problem: I like the feature of external references and how (since the new references field) multiple ones can be added. Now I wanted to check this references regarding changes. I.e. in case the external content changes a "suspect" or "needs review" validation message comes up so that the external content needs to be reviewed against the requirement again. With this a tighter connection between the requirement and the implementation can be achieved.

Solution suggestion 1:

• use the "keyword" feature of an ext ref to not only check for existence, but to define a range e.g. via ....
• have a "stamp" field added to the references items that trackes the defined content
• provide a reviewref command to review single references, all references of a req, or all ext references of a doc or doc tree
• make this feature optional so that it can/must be explicitely enabled in the document configuration

Solution suggestion 2:

• keep it independent from the doorstop code
• same keyword behavior as above for defining ranges
• but keep track of the hashes in an extern file or one file for each ext reference (.doorstop-refhashdb within the project root, for example)
• with this no code changes at all are needed

I have implemented both approaches in a POC manner, i.e. no test yet, but basically working. I'll post the link as soon as it's pushed.

[ckolumbus]

Here's the feature implemented as completely independent external script on the feat/reference_hashes_ext branch, utilizing the doorstop python API.

And on the feat/reference_hashes branch the internal implementation as new command inside doorstop itself.

Please see this as a basis for discussion and don't be too harsh when looking at the code 😉 . Any feedback is welcome!