Merge pull request #210 from michaelnt/strict_children

Warn if an item doesn't have a link from every child document

doorstop/cli/main.py

@@ -52,6 +52,8 @@ def main(args=None):  # pylint: disable=R0915
                         help="do not validate external file references")
     parser.add_argument('-C', '--no-child-check', action='store_true',
                         help="do not validate child (reverse) links")
+    parser.add_argument('-Z', '--strict-child-check', action='store_true',
+                        help="require child (reverse) links from every document")
     parser.add_argument('-S', '--no-suspect-check', action='store_true',
                         help="do not check for suspect links")
     parser.add_argument('-W', '--no-review-check', action='store_true',

doorstop/cli/utilities.py

@@ -90,6 +90,8 @@ def configure_settings(args):
         settings.CHECK_REF = args.no_ref_check is False
     if args.no_child_check is not None:
         settings.CHECK_CHILD_LINKS = args.no_child_check is False
+    if args.strict_child_check is not None:
+        settings.CHECK_CHILD_LINKS_STRICT = args.strict_child_check is True
     if args.no_suspect_check is not None:
         settings.CHECK_SUSPECT_LINKS = args.no_suspect_check is False
     if args.no_review_check is not None:

doorstop/core/document.py

@@ -53,6 +53,7 @@ def __init__(self, path, root=os.getcwd(), **kwargs):
         self._data['parent'] = None  # the root document does not have a parent
         self._items = []
         self._itered = False
+        self.children = []
 
     def __repr__(self):
         return "Document('{}')".format(self.path)

doorstop/core/item.py

@@ -560,7 +560,8 @@ def get_issues(self, skip=None, **kwargs):
 
         # Check links against both document and tree
         if self.document and self.tree:
-            yield from self._get_issues_both(self.document, self.tree, skip)
+            yield from self._get_issues_both(self.document, self.tree,
+                                             skip)
 
         # Check review status
         if not self.reviewed:
@@ -662,9 +663,11 @@ def _get_issues_both(self, document, tree, skip):
 
         # Verify an item is being linked to (child links)
         if settings.CHECK_CHILD_LINKS and self.normative:
+            find_all = settings.CHECK_CHILD_LINKS_STRICT or False
             items, documents = self._find_child_objects(document=document,
                                                         tree=tree,
-                                                        find_all=False)
+                                                        find_all=find_all)
+
             if not items:
                 for document in documents:
                     if document.prefix in skip:
@@ -673,6 +676,14 @@ def _get_issues_both(self, document, tree, skip):
                         continue
                     msg = "no links from child document: {}".format(document)
                     yield DoorstopWarning(msg)
+            elif settings.CHECK_CHILD_LINKS_STRICT:
+                prefix = [item.prefix for item in items]
+                for child in document.children:
+                    if child in skip:
+                        continue
+                    if child not in prefix:
+                        msg = 'no links from document: {}'.format(child)
+                        yield DoorstopWarning(msg)
 
     @requires_tree
     def find_ref(self):

doorstop/core/tree.py

@@ -176,6 +176,9 @@ def _place(self, document):
             log.info("parent options: {}".format(prefixes))
             raise DoorstopError(msg)
 
+        for document in self:
+            children = self._get_prefix_of_children(document)
+            document.children = children
     # attributes #############################################################
 
     @property
@@ -477,6 +480,15 @@ def by_uid(row):
         # Sort rows
         return sorted(rows, key=by_uid)
 
+    def _get_prefix_of_children(self, document):
+        """Return the prefixes of the children of this document."""
+        for child in self.children:
+            if child.document == document:
+                children = [c.document.prefix for c in child.children]
+                return children
+        children = [c.document.prefix for c in self.children]
+        return children
+
     def _iter_rows(self, item, mapping, parent=True, child=True, row=None):  # pylint: disable=R0913
         """Generate all traceability row slices.
 

doorstop/settings.py

@@ -30,6 +30,7 @@
 CHECK_LEVELS = True  # validate document levels during validation
 CHECK_REF = True  # validate external file references
 CHECK_CHILD_LINKS = True  # validate reverse links
+CHECK_CHILD_LINKS_STRICT = False  # require child (reverse) links from every document
 CHECK_SUSPECT_LINKS = True  # check stamps on links
 CHECK_REVIEW_STATUS = True  # check stamps on items
 WARN_ALL = False  # display info-level issues as warnings