add _SerializedRelationship value type

Steve Canny · Steve Canny · commit 81e047ef8a84 · 2013-08-05T14:56:08.000-07:00
diff --git a/opc/pkgreader.py b/opc/pkgreader.py
@@ -12,6 +12,7 @@
 (OPC) package.
 """
 
+from opc.constants import RELATIONSHIP_TARGET_MODE as RTM
 from opc.oxml import oxml_fromstring
 from opc.packuri import PACKAGE_URI
 from opc.phys_pkg import PhysPkgReader
@@ -123,6 +124,49 @@ class _SerializedRelationship(object):
     Serialized, in this case, means any target part is referred to via its
     partname rather than a direct link to an in-memory |Part| object.
     """
+    def __init__(self, baseURI, rel_elm):
+        super(_SerializedRelationship, self).__init__()
+        self._rId = rel_elm.rId
+        self._reltype = rel_elm.reltype
+        self._target_mode = rel_elm.target_mode
+        self._target_ref = rel_elm.target_ref
+
+    @property
+    def is_external(self):
+        """
+        True if target_mode is ``RTM.EXTERNAL``
+        """
+        return self._target_mode == RTM.EXTERNAL
+
+    @property
+    def reltype(self):
+        """Relationship type, like ``RT.OFFICE_DOCUMENT``"""
+        return self._reltype
+
+    @property
+    def rId(self):
+        """
+        Relationship id, like 'rId9', corresponds to the ``Id`` attribute on
+        the ``CT_Relationship`` element.
+        """
+        return self._rId
+
+    @property
+    def target_mode(self):
+        """
+        String in ``TargetMode`` attribute of ``CT_Relationship`` element,
+        one of ``RTM.INTERNAL`` or ``RTM.EXTERNAL``.
+        """
+        return self._target_mode
+
+    @property
+    def target_ref(self):
+        """
+        String in ``Target`` attribute of ``CT_Relationship`` element, a
+        relative part reference for internal target mode or an arbitrary URI,
+        e.g. an HTTP URL, for external target mode.
+        """
+        return self._target_ref
 
 
 class _SerializedRelationshipCollection(object):
diff --git a/tests/test_pkgreader.py b/tests/test_pkgreader.py
@@ -13,9 +13,11 @@
 
 from mock import call, Mock, patch
 
+from opc.constants import RELATIONSHIP_TARGET_MODE as RTM
 from opc.phys_pkg import ZipPkgReader
 from opc.pkgreader import (
-    _ContentTypeMap, PackageReader, _SerializedRelationshipCollection
+    _ContentTypeMap, PackageReader, _SerializedRelationship,
+    _SerializedRelationshipCollection
 )
 
 from .unitutil import class_mock, initializer_mock, method_mock
@@ -179,6 +181,32 @@ def it_can_retrieve_srels_for_a_source_uri(
         assert retval == srels
 
 
+class Describe_SerializedRelationship(object):
+
+    def it_remembers_construction_values(self):
+        # test data --------------------
+        rel_elm = Mock(
+            name='rel_elm', rId='rId9', reltype='ReLtYpE',
+            target_ref='docProps/core.xml', target_mode=RTM.INTERNAL
+        )
+        # exercise ---------------------
+        srel = _SerializedRelationship('/', rel_elm)
+        # verify -----------------------
+        assert srel.rId == 'rId9'
+        assert srel.reltype == 'ReLtYpE'
+        assert srel.target_ref == 'docProps/core.xml'
+        assert srel.target_mode == RTM.INTERNAL
+
+    def it_knows_when_it_is_external(self):
+        cases = (RTM.INTERNAL, RTM.EXTERNAL, 'FOOBAR')
+        expected_values = (False, True, False)
+        for target_mode, expected_value in zip(cases, expected_values):
+            rel_elm = Mock(name='rel_elm', rId=None, reltype=None,
+                           target_ref=None, target_mode=target_mode)
+            srel = _SerializedRelationship(None, rel_elm)
+            assert srel.is_external is expected_value
+
+
 class Describe_SerializedRelationshipCollection(object):
 
     @pytest.fixture
