ixbrl-viewer 1.4.21__py3-none-any.whl → 1.4.49__py3-none-any.whl

tests/unit_tests/iXBRLViewerPlugin/test_iXBRLViewer.py

@@ -105,6 +105,30 @@ class TestIXBRLViewer:
             namespaceURI='http://www.xbrl.org/2003/iso4217'
         )
 
+        self.monetary_type = Mock(
+            qname = Mock(
+                localName="monetaryItemType",
+                prefix="xbrli",
+                namespaceURI="http://www.xbrl.org/2003/instance"
+            )
+        )
+
+        self.string_type = Mock(
+            qname = Mock(
+                localName="stringItemType",
+                prefix="xbrli",
+                namespaceURI="http://www.xbrl.org/2003/instance"
+            )
+        )
+
+        self.integer_simple_type = Mock(
+            qname = Mock(
+                localName="integer",
+                prefix="xs",
+                namespaceURI="http://www.w3.org/2001/XMLSchema"
+            )
+        )
+
         self.usd_unit = Mock(
             measures = ([self.usd_qname],[])
         )
@@ -119,7 +143,9 @@ class TestIXBRLViewer:
                 prefix='us-gaap',
                 namespaceURI='http://viewer.com'
             ),
+            balance="debit",
             isTypedDimension=False,
+            type=self.monetary_type,
         )
 
         to_concept = Mock(
@@ -128,7 +154,9 @@ class TestIXBRLViewer:
                 prefix='us-gaap',
                 namespaceURI='http://viewer.com'
             ),
+            balance="credit",
             isTypedDimension=False,
+            type=self.monetary_type,
         )
         from_concept = Mock(
             qname=Mock(
@@ -136,7 +164,9 @@ class TestIXBRLViewer:
                 prefix='us-gaap',
                 namespaceURI='http://viewer.com'
             ),
+            balance=None,
             isTypedDimension=False,
+            type=self.monetary_type,
         )
 
         dimension_concept = Mock(
@@ -145,7 +175,9 @@ class TestIXBRLViewer:
                 prefix='us-gaap',
                 namespaceURI='http://viewer.com'
             ),
+            balance=None,
             isTypedDimension=False,
+            type=self.string_type,
         )
 
         typed_dimension_domain_concept = Mock(
@@ -154,7 +186,9 @@ class TestIXBRLViewer:
                 prefix='us-gaap',
                 namespaceURI='http://viewer.com'
             ),
+            balance=None,
             isTypedDimension=False,
+            type=self.string_type,
         )
 
         typed_dimension_concept = Mock(
@@ -163,8 +197,10 @@ class TestIXBRLViewer:
                 prefix='us-gaap',
                 namespaceURI='http://viewer.com'
             ),
+            balance=None,
             isTypedDimension=True,
             typedDomainElement=typed_dimension_domain_concept,
+            type=self.integer_simple_type,
         )
 
         member_concept = Mock(
@@ -173,7 +209,9 @@ class TestIXBRLViewer:
                 prefix='us-gaap',
                 namespaceURI='http://viewer.com'
             ),
+            balance=None,
             isTypedDimension=False,
+            type=self.string_type,
         )
 
         rel = Mock(
@@ -245,6 +283,7 @@ class TestIXBRLViewer:
             qname=self.cash_concept.qname,
             value=100,
             isNumeric=False,
+            isTuple=False,
             context=context_1,
             concept=self.cash_concept,
             format='format'
@@ -256,6 +295,7 @@ class TestIXBRLViewer:
             concept=self.cash_concept,
             context=context_2,
             isNumeric=True,
+            isTuple=False,
             unit=self.usd_unit,
             value=None,
             decimals=None,
@@ -269,6 +309,7 @@ class TestIXBRLViewer:
             concept=self.cash_concept,
             context=context_2,
             isNumeric=True,
+            isTuple=False,
             unit=self.null_units,
             value=None,
             decimals=None,
@@ -281,6 +322,7 @@ class TestIXBRLViewer:
             qname=self.cash_concept.qname,
             value=10,
             isNumeric=False,
+            isTuple=False,
             context=context_with_typed_dimension,
             concept=self.cash_concept,
             format='format'
@@ -291,11 +333,31 @@ class TestIXBRLViewer:
             qname=self.cash_concept.qname,
             value=1000,
             isNumeric=False,
+            isTuple=False,
             context=context_with_missing_member_on_dimension,
             concept=self.cash_concept,
             format='format'
         )
 
+        file_1 = Mock(
+            filename='something/reports/001.jpg'
+        )
+
+        file_2 = Mock(
+            filename='something/reports/002.jpg'
+        )
+
+        fs = Mock(
+            filelist = [file_1, file_2]
+        )
+
+        file_source = Mock(
+            fs = fs
+        )
+
+        def creationSoftwareMatches_effect(text):
+            return ["Example Software Name"]
+
         def fromModelObjects_effect(concept):
             return []
 
@@ -358,20 +420,10 @@ class TestIXBRLViewer:
             ixdsTarget=None,
         )
 
-        error1 = logging.LogRecord("arelle", logging.ERROR, "", 0, "Error message", {}, None)    
-        error1.messageCode = "code1"
-        self.modelManager = Mock(
-            cntlr = Mock(
-                logHandler = Mock (
-                    logRecordBuffer = [
-                        error1
-                    ]
-                )
-            )
-        )
 
         def urlDocEntry(path, docType, linkQName=None):
             return path, Mock(
+                creationSoftwareMatches=creationSoftwareMatches_effect,
                 type=docType,
                 basename=os.path.basename(path),
                 xmlRootElement=Mock(
@@ -388,9 +440,9 @@ class TestIXBRLViewer:
             baseSets=baseSets,
             roleTypes=roleTypes,
             facts=[fact_1, fact_with_typed_dimension, fact_with_missing_member_on_dimension],
+            fileSource=file_source,
             info=info_effect,
             modelDocument=self.modelDocument,
-            modelManager=self.modelManager,
             ixdsTarget=None,
             urlDocs=dict((
                 urlDocEntry('/filesystem/local-inline.htm', Type.INLINEXBRL),
@@ -419,9 +471,9 @@ class TestIXBRLViewer:
             baseSets=baseSets,
             roleTypes=roleTypes,
             facts=[fact_2, fact_3],
+            fileSource=file_source,
             info=info_effect,
             modelDocument=self.modelDocument,
-            modelManager=self.modelManager,
             ixdsTarget=None,
             urlDocs={}
         )
@@ -431,9 +483,9 @@ class TestIXBRLViewer:
             baseSets=baseSets,
             roleTypes=roleTypes,
             facts=[fact_1, fact_with_typed_dimension, fact_with_missing_member_on_dimension],
+            fileSource=file_source,
             info=info_effect,
             modelDocument=self.modelDocumentInlineSet,
-            modelManager=self.modelManager,
             ixdsTarget=None,
             urlDocs={}
         )
@@ -446,15 +498,20 @@ class TestIXBRLViewer:
         typed_dimension_domain_concept.modelXbrl = self.modelXbrl_1
         member_concept.modelXbrl = self.modelXbrl_1
 
-        self.builder_1 = IXBRLViewerBuilder([self.modelXbrl_1])
-        self.builder_2 = IXBRLViewerBuilder([self.modelXbrl_1])
-        self.builder_3 = IXBRLViewerBuilder([self.modelXbrl_2])
-        self.builder_doc_set = IXBRLViewerBuilder([self.modelXbrlDocSet])
+        self.logRecordBuffer = []
+        self.cntlr_mock = Mock(
+            logHandler = Mock(
+                logRecordBuffer = self.logRecordBuffer
+            )
+        )
+        self.builder_1 = IXBRLViewerBuilder(self.cntlr_mock)
+        self.builder_doc_set = IXBRLViewerBuilder(self.cntlr_mock)
+
 
     @patch('arelle.XbrlConst.conceptLabel', 'http://www.xbrl.org/2003/arcrole/concept-label')
     @patch('arelle.XbrlConst.conceptReference', 'http://www.xbrl.org/2003/arcrole/concept-reference')
     def test_addConcept_simple_case(self):
-        builder = IXBRLViewerBuilder([self.modelXbrl_1])
+        builder = IXBRLViewerBuilder(Mock())
         builder.currentTargetReport = builder.newTargetReport(None)
         builder.addSourceReport()["targetReports"].append(builder.currentTargetReport)
         builder.addConcept(self.modelXbrl_1, self.cash_concept)
@@ -464,39 +521,39 @@ class TestIXBRLViewer:
     @patch('arelle.XbrlConst.summationItem', 'http://www.xbrl.org/2003/arcrole/summation-item')
     def test_getRelationships_simple_case(self):
         modelXbrl = Mock(baseSets=defaultdict(list), relationshipSets={})
-        builder = IXBRLViewerBuilder([modelXbrl])
+        builder = IXBRLViewerBuilder(Mock())
         result = builder.getRelationships(modelXbrl)
         assert result == {}
 
     @patch('arelle.XbrlConst.parentChild', 'http://www.xbrl.org/2003/arcrole/parent-child')
     @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 = IXBRLViewerBuilder(Mock())
         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')
         assert result.get(siPrefix).get(roleMap.getPrefix('ELR')).get('us-gaap:from_concept')
 
-    def test_addELR_no_definition(self):
+    def test_addRoleDefinition_no_definition(self):
         """
         Adding an ELR with no definition should result in no entry in the roleDefs map
         """
         elr = "http://example.com/unknownELR"
-        builder = IXBRLViewerBuilder([self.modelXbrl_1])
+        builder = IXBRLViewerBuilder(Mock())
         builder.currentTargetReport = builder.newTargetReport(None)
-        builder.addELR(self.modelXbrl_1, elr)
+        builder.addRoleDefinition(self.modelXbrl_1, elr)
         elrPrefix = builder.roleMap.getPrefix(elr)
         assert builder.currentTargetReport.get('roleDefs').get(elrPrefix) is None
 
-    def test_addELR_with_definition(self):
+    def test_addRoleDefinition_with_definition(self):
         """
         Adding an ELR with a definition should result in an "en" label with the definition as its value.
         """
         elr = "ELR"
-        builder = IXBRLViewerBuilder([self.modelXbrl_1])
+        builder = IXBRLViewerBuilder(Mock())
         builder.currentTargetReport = builder.newTargetReport(None)
-        builder.addELR(self.modelXbrl_1, elr)
+        builder.addRoleDefinition(self.modelXbrl_1, elr)
         elrPrefix = builder.roleMap.getPrefix(elr)
         assert builder.currentTargetReport.get('roleDefs').get(elrPrefix).get("en") == "ELR Label"
 
@@ -509,7 +566,13 @@ class TestIXBRLViewer:
     @patch('arelle.XbrlConst.documentationLabel', 'http://www.xbrl.org/2003/role/documentation')
     def test_createViewerWithValidation(self):
         js_uri = 'ixbrlviewer.js'
-        builder = IXBRLViewerBuilder([self.modelXbrl_1])
+
+        error1 = logging.LogRecord("arelle", logging.ERROR, "", 0, "Error message", {}, None)    
+        error1.messageCode = "code1"
+        self.logRecordBuffer.append(error1)
+
+        builder = IXBRLViewerBuilder(self.cntlr_mock)
+        builder.processModel(self.modelXbrl_1)
         result = builder.createViewer(js_uri)
         assert len(result.files) == 1
         body = result.files[0].xmlDocument.getroot()[0]
@@ -523,6 +586,7 @@ class TestIXBRLViewer:
         errors = jsdata["validation"]
         assert errors == [{"sev": "ERROR", "msg": "Error message", "code": "code1" }]
         assert set(jsdata["sourceReports"][0]["targetReports"][0]["facts"]) == {"fact_id1", "fact_typed_dimension", "fact_dimension_missing_member"}
+        assert jsdata["sourceReports"][0]["targetReports"][0]["softwareCredits"] == ["Example Software Name"]
 
     @patch('arelle.XbrlConst.conceptLabel', 'http://www.xbrl.org/2003/arcrole/concept-label')
     @patch('arelle.XbrlConst.conceptReference', 'http://www.xbrl.org/2003/arcrole/concept-reference')
@@ -533,7 +597,8 @@ class TestIXBRLViewer:
     @patch('arelle.XbrlConst.dimensionDefault', 'http://xbrl.org/int/dim/arcrole/dimension-default')
     def test_createViewer(self):
         js_uri = 'ixbrlviewer.js'
-        builder = IXBRLViewerBuilder([self.modelXbrl_1])
+        builder = IXBRLViewerBuilder(self.cntlr_mock)
+        builder.processModel(self.modelXbrl_1)
         result = builder.createViewer(js_uri, showValidations = False)
         assert len(result.files) == 1
         body = result.files[0].xmlDocument.getroot()[0]
@@ -548,13 +613,13 @@ class TestIXBRLViewer:
         reportData = jsdata["sourceReports"][0]["targetReports"][0]
         assert set(reportData["facts"]) == {"fact_id1", "fact_typed_dimension", "fact_dimension_missing_member"}
         assert reportData["concepts"] == {
-            'us-gaap:Cash': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:from_concept': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:to_concept': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:dimension': {'d': 'e', 'e': True, 't': True, 'labels': {}},
-            'us-gaap:member': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:typed_dimension_domain': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:typed_dimension': {'d': 't', 'e': True, 't': True, 'labels': {}, 'td': 'us-gaap:typed_dimension_domain'},
+            'us-gaap:Cash': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:monetaryItemType', 'b': 'debit'},
+            'us-gaap:from_concept': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:monetaryItemType'},
+            'us-gaap:to_concept': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:monetaryItemType', 'b': 'credit'},
+            'us-gaap:dimension': {'d': 'e', 'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:stringItemType'},
+            'us-gaap:member': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:stringItemType'},
+            'us-gaap:typed_dimension_domain': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:stringItemType'},
+            'us-gaap:typed_dimension': {'d': 't', 'e': True, 't': True, 'labels': {}, 'td': 'us-gaap:typed_dimension_domain', 'dt': 'xs:integer'},
         }
         assert reportData["localDocs"] == {
             'local-inline.htm': ['inline'],
@@ -578,8 +643,9 @@ class TestIXBRLViewer:
     @patch('arelle.XbrlConst.dimensionDefault', 'http://xbrl.org/int/dim/arcrole/dimension-default')
     def test_createStubViewer(self):
         js_uri = 'ixbrlviewer.js'
-        builder = IXBRLViewerBuilder([self.modelXbrl_1])
-        result = builder.createViewer(js_uri, showValidations = False, useStubViewer = True)
+        builder = IXBRLViewerBuilder(self.cntlr_mock, useStubViewer = True)
+        builder.processModel(self.modelXbrl_1)
+        result = builder.createViewer(js_uri, showValidations = False)
         assert len(result.files) == 2
         body = result.files[0].xmlDocument.getroot().find('{http://www.w3.org/1999/xhtml}body')
         assert body[0].text == 'BEGIN IXBRL VIEWER EXTENSIONS'
@@ -593,13 +659,13 @@ class TestIXBRLViewer:
         reportData = jsdata["sourceReports"][0]["targetReports"][0]
         assert set(reportData["facts"]) == {"fact_id1", "fact_typed_dimension", "fact_dimension_missing_member"}
         assert reportData["concepts"] == {
-            'us-gaap:Cash': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:from_concept': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:to_concept': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:dimension': {'d': 'e', 'e': True, 't': True, 'labels': {}},
-            'us-gaap:member': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:typed_dimension_domain': {'e': True, 't': True, 'labels': {}},
-            'us-gaap:typed_dimension': {'d': 't', 'e': True, 't': True, 'labels': {}, 'td': 'us-gaap:typed_dimension_domain'},
+            'us-gaap:Cash': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:monetaryItemType', 'b': 'debit'},
+            'us-gaap:from_concept': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:monetaryItemType'},
+            'us-gaap:to_concept': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:monetaryItemType', 'b': 'credit'},
+            'us-gaap:dimension': {'d': 'e', 'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:stringItemType'},
+            'us-gaap:member': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:stringItemType'},
+            'us-gaap:typed_dimension_domain': {'e': True, 't': True, 'labels': {}, 'dt': 'xbrli:stringItemType'},
+            'us-gaap:typed_dimension': {'d': 't', 'e': True, 't': True, 'labels': {}, 'td': 'us-gaap:typed_dimension_domain', 'dt': 'xs:integer'},
         }
         assert reportData["localDocs"] == {
             'local-inline.htm': ['inline'],
@@ -623,6 +689,7 @@ class TestIXBRLViewer:
     @patch('arelle.XbrlConst.dimensionDefault', 'http://xbrl.org/int/dim/arcrole/dimension-default')
     def test_createViewer_docset(self):
         js_uri = 'ixbrlviewer.js'
+        self.builder_doc_set.processModel(self.modelXbrlDocSet)
         result = self.builder_doc_set.createViewer(js_uri, showValidations=False)
         assert len(result.files) == 2
         body = result.files[0].xmlDocument.getroot()[0]
@@ -651,7 +718,8 @@ class TestIXBRLViewer:
     @patch('arelle.XbrlConst.documentationLabel', 'http://www.xbrl.org/2003/role/documentation')
     def test_createViewer_bad_path(self):
         js_uri = 'ixbrlviewer.js'
-        builder = IXBRLViewerBuilder([self.modelXbrl_2])
+        builder = IXBRLViewerBuilder(self.cntlr_mock)
+        builder.processModel(self.modelXbrl_2)
         result = builder.createViewer(js_uri)
         assert len(result.files) == 1
         body = result.files[0].xmlDocument.getroot()[0]
@@ -675,17 +743,15 @@ class TestIXBRLViewer:
         """
         Enable a defined feature
         """
-        builder = IXBRLViewerBuilder([self.modelXbrl_1])
-        builder.enableFeature('review')
-        assert builder.taxonomyData["features"] == ['review']
+        builder = IXBRLViewerBuilder(Mock(), features={'review': True})
+        assert builder.taxonomyData["features"] == {'review': True}
 
     def test_enableFeature_invalid(self):
         """
         Attempt to enable an undefined feature
         """
-        builder = IXBRLViewerBuilder([self.modelXbrl_1])
         with pytest.raises(AssertionError, match=rf'^Given feature name `unknown` does not match any defined features'):
-            builder.enableFeature('unknown')
+            IXBRLViewerBuilder(Mock(), features={'unknown': True})
 
     def test_xhtmlNamespaceHandling(self):
         # Check the prefix used for our inserted script tags