Merge pull request #627 from paulwarren-wk/show-target-document

Display the target document of facts in inspector and search
Arelle · Feb 15, 2024 · 4bec74f · 4bec74f
2 parents ebdc9d6 + 16bd5b5
commit 4bec74f
Show file tree

Hide file tree

Showing 9 changed files with 61 additions and 17 deletions.
diff --git a/iXBRLViewerPlugin/iXBRLViewer.py b/iXBRLViewerPlugin/iXBRLViewer.py
@@ -381,10 +381,11 @@ def getStubDocument(self):
         with open(os.path.join(os.path.dirname(__file__),"stubviewer.html")) as fin:
             return etree.parse(fin)
 
-    def newTargetReport(self):
+    def newTargetReport(self, target):
         return {
             "concepts": {},
             "facts": {},
+            "target": target,
         }
 
     def addSourceReport(self):
@@ -425,7 +426,7 @@ def createViewer(
 
         for n, report in enumerate(self.reports):
             self.footnoteRelationshipSet = ModelRelationshipSet(report, "XBRL-footnotes")
-            self.currentTargetReport = self.newTargetReport()
+            self.currentTargetReport = self.newTargetReport(getattr(report, "ixdsTarget", None))
             for f in report.facts:
                 self.addFact(report, f)
             self.currentTargetReport["rels"] = self.getRelationships(report)

diff --git a/iXBRLViewerPlugin/viewer/src/html/inspector.html b/iXBRLViewerPlugin/viewer/src/html/inspector.html
@@ -183,8 +183,11 @@ <h3 class="collapsible-header">
           <p class="title" data-i18n="inspector.noFactSelected">No Fact Selected</p>
         </div>
         <div class="fact-selected-only">
-          <div class="hidden-fact-tag" data-i18n="inspector.hiddenFact">Hidden Fact</div>
-          <div class="html-hidden-fact-tag" data-i18n="inspector.concealedFact">Concealed Fact</div>
+          <div class="tags">
+            <div class="target-document"></div>
+            <div class="hidden-fact-tag" data-i18n="inspector.hiddenFact">Hidden Fact</div>
+            <div class="html-hidden-fact-tag" data-i18n="inspector.concealedFact">Concealed Fact</div>
+          </div>
           <div class="collapsible-section">
             <div class="fact-inspector collapsible-body">
             </div>

diff --git a/iXBRLViewerPlugin/viewer/src/js/fact.js b/iXBRLViewerPlugin/viewer/src/js/fact.js
@@ -404,4 +404,8 @@ export class Fact {
         }
         return this.decimals() > of.decimals();
     }
+
+    targetDocument() {
+        return this.report.targetDocument();
+    }
 }
diff --git a/iXBRLViewerPlugin/viewer/src/js/inspector.js b/iXBRLViewerPlugin/viewer/src/js/inspector.js
@@ -313,15 +313,21 @@ export class Inspector {
                     .appendTo(row);
             }
         }
+        const tags = $("<div></div>").addClass("tags").appendTo(row);
+        if (f.targetDocument() !== null) {
+            $('<div class="hidden"></div>')
+                .text(f.targetDocument())
+                .appendTo(tags);
+        }
         if (f.isHidden()) {
             $('<div class="hidden"></div>')
                 .text(i18next.t("search.hiddenFact"))
-                .appendTo(row);
+                .appendTo(tags);
         }
         else if (f.isHTMLHidden()) {
             $('<div class="hidden"></div>')
                 .text(i18next.t("search.concealedFact"))
-                .appendTo(row);
+                .appendTo(tags);
         }
         return row;
     }
@@ -1076,6 +1082,14 @@ export class Inspector {
                     $('#inspector').addClass('html-hidden-fact');
                 }
 
+                const target = cf.targetDocument();
+                if (target !== null) {
+                    $('#inspector .target-document').text(target).show();
+                }
+                else {
+                    $('#inspector .target-document').hide();
+                }
+
             }
             else if (cf instanceof Footnote) {
                 $('#inspector').addClass('footnote-mode');

diff --git a/iXBRLViewerPlugin/viewer/src/js/report.js b/iXBRLViewerPlugin/viewer/src/js/report.js
@@ -38,6 +38,10 @@ export class XBRLReport {
         return this.reportSet.factsForReport(this);
     }
 
+    targetDocument() {
+        return this._reportData.target ?? null;
+    }
+
     getChildRelationships(conceptName, arcrole) {
         const rels = {}
         const elrs = this._reportData.rels[arcrole] || {};

diff --git a/iXBRLViewerPlugin/viewer/src/less/block-list.less b/iXBRLViewerPlugin/viewer/src/less/block-list.less
@@ -12,6 +12,11 @@
     margin: 0.8rem 0;
   }
 
+  // Contents of .tags provide 0.2rem of non-collapsing margin
+  & > .tags {
+    margin: 0.6rem 0;
+  }
+
   &:hover {
     background-color: @background-selected;
   }

diff --git a/iXBRLViewerPlugin/viewer/src/less/components.less b/iXBRLViewerPlugin/viewer/src/less/components.less
@@ -1,13 +1,15 @@
 // See COPYRIGHT.md for copyright information
 
 .tag {
-  display: table;
+  display: inline-block;
   text-transform: uppercase;
   font-weight: bold;
   background-color: @background-tag;
   padding: 0.15em 0.5em;
   color: #fff;
   border-radius: 0.3em;
+  margin: 0.2rem 0.3rem 0.2rem 0;
+  white-space: nowrap;
 }
 
 .clickable {

diff --git a/iXBRLViewerPlugin/viewer/src/less/inspector.less b/iXBRLViewerPlugin/viewer/src/less/inspector.less
@@ -676,13 +676,19 @@
       top: 1px;
     }
 
-    .hidden-fact-tag,
-    .html-hidden-fact-tag {
-      .tag();
-
+    .inspector-body-fact .tags {
       position: absolute;
       top: 1.5rem;
       right: 0.9rem;
+    }
+
+    .target-document {
+      .tag();
+    }
+
+    .hidden-fact-tag,
+    .html-hidden-fact-tag {
+      .tag();
 
       &.html-hidden-fact-tag {
         background-color: #c63018;

diff --git a/tests/unit_tests/iXBRLViewerPlugin/test_iXBRLViewer.py b/tests/unit_tests/iXBRLViewerPlugin/test_iXBRLViewer.py
@@ -328,7 +328,8 @@ def info_effect(info, msg):
                 "filepath":'a.html',
                 "objectIndex":0,
                 "type":Type.INLINEXBRL,
-            }
+            },
+            ixdsTarget=None,
         )
 
         self.modelDocumentInlineSet = Mock(
@@ -353,7 +354,8 @@ def info_effect(info, msg):
                 ): [],
             },
             filepath=self.modelDocument.filepath,
-            type=Type.INLINEXBRLDOCUMENTSET
+            type=Type.INLINEXBRLDOCUMENTSET,
+            ixdsTarget=None,
         )
 
         error1 = logging.LogRecord("arelle", logging.ERROR, "", 0, "Error message", {}, None)    
@@ -389,6 +391,7 @@ def urlDocEntry(path, docType, linkQName=None):
             info=info_effect,
             modelDocument=self.modelDocument,
             modelManager=self.modelManager,
+            ixdsTarget=None,
             urlDocs=dict((
                 urlDocEntry('/filesystem/local-inline.htm', Type.INLINEXBRL),
                 urlDocEntry('https://example.com/remote-inline.htm', Type.INLINEXBRL),
@@ -419,6 +422,7 @@ def urlDocEntry(path, docType, linkQName=None):
             info=info_effect,
             modelDocument=self.modelDocument,
             modelManager=self.modelManager,
+            ixdsTarget=None,
             urlDocs={}
         )
         self.modelXbrlDocSet = Mock(
@@ -430,6 +434,7 @@ def urlDocEntry(path, docType, linkQName=None):
             info=info_effect,
             modelDocument=self.modelDocumentInlineSet,
             modelManager=self.modelManager,
+            ixdsTarget=None,
             urlDocs={}
         )
 
@@ -450,7 +455,7 @@ def urlDocEntry(path, docType, linkQName=None):
     @patch('arelle.XbrlConst.conceptReference', 'http://www.xbrl.org/2003/arcrole/concept-reference')
     def test_addConcept_simple_case(self):
         builder = IXBRLViewerBuilder([self.modelXbrl_1])
-        builder.currentTargetReport = builder.newTargetReport()
+        builder.currentTargetReport = builder.newTargetReport(None)
         builder.addSourceReport()["targetReports"].append(builder.currentTargetReport)
         builder.addConcept(self.modelXbrl_1, self.cash_concept)
         assert builder.taxonomyData["sourceReports"][0]["targetReports"][0].get('concepts').get('us-gaap:Cash')
@@ -467,7 +472,7 @@ def test_getRelationships_simple_case(self):
     @patch('arelle.XbrlConst.summationItem', 'http://www.xbrl.org/2003/arcrole/summation-item')
     def test_getRelationships_returns_a_rel(self):
         builder = IXBRLViewerBuilder([self.modelXbrl_1])
-        builder.currentTargetReport = builder.newTargetReport()
+        builder.currentTargetReport = builder.newTargetReport(None)
         result = builder.getRelationships(self.modelXbrl_1)
         roleMap = builder.roleMap
         siPrefix = roleMap.getPrefix('http://www.xbrl.org/2003/arcrole/summation-item')
@@ -479,7 +484,7 @@ def test_addELR_no_definition(self):
         """
         elr = "http://example.com/unknownELR"
         builder = IXBRLViewerBuilder([self.modelXbrl_1])
-        builder.currentTargetReport = builder.newTargetReport()
+        builder.currentTargetReport = builder.newTargetReport(None)
         builder.addELR(self.modelXbrl_1, elr)
         elrPrefix = builder.roleMap.getPrefix(elr)
         assert builder.currentTargetReport.get('roleDefs').get(elrPrefix) is None
@@ -490,7 +495,7 @@ def test_addELR_with_definition(self):
         """
         elr = "ELR"
         builder = IXBRLViewerBuilder([self.modelXbrl_1])
-        builder.currentTargetReport = builder.newTargetReport()
+        builder.currentTargetReport = builder.newTargetReport(None)
         builder.addELR(self.modelXbrl_1, elr)
         elrPrefix = builder.roleMap.getPrefix(elr)
         assert builder.currentTargetReport.get('roleDefs').get(elrPrefix).get("en") == "ELR Label"