add OpcPackage.save()

Steve Canny · Steve Canny · commit ba56ea4f209d · 2013-08-05T15:08:41.000-07:00
diff --git a/opc/package.py b/opc/package.py
@@ -13,6 +13,7 @@
 
 from opc.packuri import PACKAGE_URI
 from opc.pkgreader import PackageReader
+from opc.pkgwriter import PackageWriter
 
 
 class OpcPackage(object):
@@ -52,6 +53,15 @@ def rels(self):
         """
         return self._rels
 
+    def save(self, pkg_file):
+        """
+        Save this package to *pkg_file*, where *file* can be either a path to
+        a file (a string) or a file-like object.
+        """
+        for part in self.parts:
+            part._before_marshal()
+        PackageWriter.write(pkg_file, self._rels, self.parts)
+
     def _add_relationship(self, reltype, target, rId, external=False):
         """
         Return newly added |_Relationship| instance of *reltype* between this
diff --git a/opc/pkgwriter.py b/opc/pkgwriter.py
@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+#
+# pkgwriter.py
+#
+# Copyright (C) 2013 Steve Canny scanny@cisco.com
+#
+# This module is part of python-opc and is released under the MIT License:
+# http://www.opensource.org/licenses/mit-license.php
+
+"""
+Provides a low-level, write-only API to a serialized Open Packaging
+Convention (OPC) package, essentially an implementation of OpcPackage.save()
+"""
+
+
+class PackageWriter(object):
+    """
+    Writes a zip-format OPC package to *pkg_file*, where *pkg_file* can be
+    either a path to a zip file (a string) or a file-like object. Its single
+    API method, :meth:`write`, is static, so this class is not intended to
+    be instantiated.
+    """
+    @staticmethod
+    def write(pkg_file, pkg_rels, parts):
+        """
+        Write a physical package (.pptx file) to *pkg_file* containing
+        *pkg_rels* and *parts* and a content types stream based on the
+        content types of the parts.
+        """
diff --git a/tests/test_package.py b/tests/test_package.py
@@ -11,7 +11,7 @@
 
 import pytest
 
-from mock import call, Mock, patch
+from mock import call, Mock, patch, PropertyMock
 
 from opc.package import (
     OpcPackage, Part, PartFactory, _Relationship, RelationshipCollection,
@@ -33,10 +33,24 @@ class DescribeOpcPackage(object):
     def PackageReader_(self, request):
         return class_mock('opc.package.PackageReader', request)
 
+    @pytest.fixture
+    def PackageWriter_(self, request):
+        return class_mock('opc.package.PackageWriter', request)
+
     @pytest.fixture
     def PartFactory_(self, request):
         return class_mock('opc.package.PartFactory', request)
 
+    @pytest.fixture
+    def parts(self, request):
+        """
+        Return a mock patching property OpcPackage.parts, reversing the
+        patch after each use.
+        """
+        _patch = patch.object(OpcPackage, 'parts', new_callable=PropertyMock)
+        request.addfinalizer(_patch.stop)
+        return _patch.start()
+
     @pytest.fixture
     def Unmarshaller_(self, request):
         return class_mock('opc.package.Unmarshaller', request)
@@ -102,6 +116,19 @@ def it_can_iterate_over_parts_by_walking_rels_graph(self):
         # verify -----------------------
         assert generated_parts == [part1, part2]
 
+    def it_can_save_to_a_pkg_file(self, PackageWriter_, parts):
+        # mockery ----------------------
+        pkg_file = Mock(name='pkg_file')
+        pkg = OpcPackage()
+        parts.return_value = parts = [Mock(name='part1'), Mock(name='part2')]
+        # exercise ---------------------
+        pkg.save(pkg_file)
+        # verify -----------------------
+        for part in parts:
+            part._before_marshal.assert_called_once_with()
+        PackageWriter_.write.assert_called_once_with(pkg_file, pkg._rels,
+                                                     parts)
+
 
 class DescribePart(object):
 
