add PackageWriter.write()

Steve Canny · Steve Canny · commit eb9c314c7da9 · 2013-08-05T15:08:41.000-07:00
diff --git a/opc/phys_pkg.py b/opc/phys_pkg.py
@@ -22,6 +22,12 @@ def __new__(cls, pkg_file):
         return ZipPkgReader(pkg_file)
 
 
+class PhysPkgWriter(object):
+    """
+    Factory for physical package writer objects.
+    """
+
+
 class ZipPkgReader(object):
     """
     Implements |PhysPkgReader| interface for a zip file OPC package.
diff --git a/opc/pkgwriter.py b/opc/pkgwriter.py
@@ -12,6 +12,8 @@
 Convention (OPC) package, essentially an implementation of OpcPackage.save()
 """
 
+from opc.phys_pkg import PhysPkgWriter
+
 
 class PackageWriter(object):
     """
@@ -27,4 +29,32 @@ def write(pkg_file, pkg_rels, parts):
         *pkg_rels* and *parts* and a content types stream based on the
         content types of the parts.
         """
+        phys_writer = PhysPkgWriter(pkg_file)
+        PackageWriter._write_content_types_stream(phys_writer, parts)
+        PackageWriter._write_pkg_rels(phys_writer, pkg_rels)
+        PackageWriter._write_parts(phys_writer, parts)
+        phys_writer.close()
+
+    @staticmethod
+    def _write_content_types_stream(phys_writer, parts):
+        """
+        Write ``[Content_Types].xml`` part to the physical package with an
+        appropriate content type lookup target for each part in *parts*.
+        """
+        raise NotImplementedError()
+
+    @staticmethod
+    def _write_parts(phys_writer, parts):
+        """
+        Write the blob of each part in *parts* to the package, along with a
+        rels item for its relationships if and only if it has any.
+        """
+        raise NotImplementedError()
+
+    @staticmethod
+    def _write_pkg_rels(phys_writer, pkg_rels):
+        """
+        Write the XML rels item for *pkg_rels* ('/_rels/.rels') to the
+        package.
+        """
         raise NotImplementedError()
diff --git a/tests/test_pkgwriter.py b/tests/test_pkgwriter.py
@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+#
+# test_pkgwriter.py
+#
+# Copyright (C) 2013 Steve Canny scanny@cisco.com
+#
+# This module is part of python-pptx and is released under the MIT License:
+# http://www.opensource.org/licenses/mit-license.php
+
+"""Test suite for opc.pkgwriter module."""
+
+import pytest
+
+from mock import call, Mock, patch
+
+from opc.pkgwriter import PackageWriter
+
+
+class DescribePackageWriter(object):
+
+    @pytest.fixture
+    def PhysPkgWriter_(self, request):
+        _patch = patch('opc.pkgwriter.PhysPkgWriter')
+        request.addfinalizer(_patch.stop)
+        return _patch.start()
+
+    @pytest.fixture
+    def _write_methods(self, request):
+        """Mock that patches all the _write_* methods of PackageWriter"""
+        root_mock = Mock(name='PackageWriter')
+        patch1 = patch.object(PackageWriter, '_write_content_types_stream')
+        patch2 = patch.object(PackageWriter, '_write_pkg_rels')
+        patch3 = patch.object(PackageWriter, '_write_parts')
+        root_mock.attach_mock(patch1.start(), '_write_content_types_stream')
+        root_mock.attach_mock(patch2.start(), '_write_pkg_rels')
+        root_mock.attach_mock(patch3.start(), '_write_parts')
+
+        def fin():
+            patch1.stop()
+            patch2.stop()
+            patch3.stop()
+
+        request.addfinalizer(fin)
+        return root_mock
+
+    def it_can_write_a_package(self, PhysPkgWriter_, _write_methods):
+        # mockery ----------------------
+        pkg_file = Mock(name='pkg_file')
+        pkg_rels = Mock(name='pkg_rels')
+        parts = Mock(name='parts')
+        phys_writer = PhysPkgWriter_.return_value
+        # exercise ---------------------
+        PackageWriter.write(pkg_file, pkg_rels, parts)
+        # verify -----------------------
+        expected_calls = [
+            call._write_content_types_stream(phys_writer, parts),
+            call._write_pkg_rels(phys_writer, pkg_rels),
+            call._write_parts(phys_writer, parts),
+        ]
+        PhysPkgWriter_.assert_called_once_with(pkg_file)
+        assert _write_methods.mock_calls == expected_calls
+        phys_writer.close.assert_called_once_with()
