acpt: add shp-inline-shape-access.feature

Steve Canny · Steve Canny · commit f8585273785c · 2013-12-24T18:32:27.000-08:00
diff --git a/docs/dev/analysis/features/shapes-inline.rst b/docs/dev/analysis/features/shapes-inline.rst
@@ -22,27 +22,6 @@ inline shape::
     >>> assert inline_shape.type == MSO_SHAPE_TYPE.PICTURE
 
 
-Acceptance test
----------------
-
-shp-inline-shape-access.feature::
-
-    Feature: Access inline shapes in document
-      In order to query or manipulate inline shapes in a document
-      As an python-docx developer
-      I need the ability to access the inline shapes in a document
-
-      Scenario: Access inline shapes collection of document
-         Given a document having two inline shapes
-          Then I can access the inline shape collection of the document
-           And the length of the inline shape collection is 2
-
-      Scenario: Access shape in inline shape collection
-         Given an inline shape collection containing two shapes
-          Then I can iterate over the inline shape collection
-           And I can access an inline shape by index
-
-
 Resources
 ---------
 
diff --git a/docx/parts.py b/docx/parts.py
@@ -88,3 +88,17 @@ def tables(self):
         they appear.
         """
         return [Table(tbl) for tbl in self._body.tbl_lst]
+
+
+class InlineShape(object):
+    """
+    Proxy for an ``<wp:inline>`` element, representing the container for an
+    inline graphical object.
+    """
+
+
+class InlineShapes(object):
+    """
+    Sequence of |InlineShape| instances, supporting len(), iteration, and
+    indexed access.
+    """
diff --git a/features/shp-inline-shape-access.feature b/features/shp-inline-shape-access.feature
@@ -0,0 +1,16 @@
+Feature: Access inline shapes in document
+  In order to query or manipulate inline shapes in a document
+  As an python-docx developer
+  I need the ability to access the inline shapes in a document
+
+  @wip
+  Scenario: Access inline shapes collection of document
+     Given a document containing two inline shapes
+      Then I can access the inline shape collection of the document
+       And the length of the inline shape collection is 2
+
+  @wip
+  Scenario: Access shape in inline shape collection
+     Given an inline shape collection containing two shapes
+      Then I can iterate over the inline shape collection
+       And I can access an inline shape by index
diff --git a/features/steps/shape.py b/features/steps/shape.py
@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+"""
+Step implementations for graphical object (shape) related features
+"""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+from behave import given, then
+
+from docx import Document
+from docx.parts import InlineShape, InlineShapes
+
+from .helpers import test_docx
+
+
+# given ===================================================
+
+@given('a document containing two inline shapes')
+def given_a_document_containing_two_inline_shapes(context):
+    docx_path = test_docx('shp-inline-shape-access')
+    context.document = Document(docx_path)
+
+
+@given('an inline shape collection containing two shapes')
+def given_inline_shape_collection_containing_two_shapes(context):
+    docx_path = test_docx('shp-inline-shape-access')
+    document = Document(docx_path)
+    context.inline_shapes = document.body.inline_shapes
+
+
+# then =====================================================
+
+@then('I can access an inline shape by index')
+def then_can_access_inline_shape_by_index(context):
+    inline_shapes = context.inline_shapes
+    for idx in range(2):
+        inline_shape = inline_shapes[idx]
+        assert isinstance(inline_shape, InlineShape)
+
+
+@then('I can access the inline shape collection of the document')
+def then_can_access_inline_shape_collection_of_document(context):
+    document = context.document
+    inline_shapes = document.inline_shapes
+    assert isinstance(inline_shapes, InlineShapes)
+
+
+@then('I can iterate over the inline shape collection')
+def then_can_iterate_over_inline_shape_collection(context):
+    inline_shapes = context.inline_shapes
+    actual_count = 0
+    for inline_shape in inline_shapes:
+        actual_count += 1
+        assert isinstance(inline_shape, InlineShape)
+    assert actual_count == 2
+
+
+@then('the length of the inline shape collection is 2')
+def then_len_of_inline_shape_collection_is_2(context):
+    inline_shapes = context.document.inline_shapes
+    assert len(inline_shapes) == 2
diff --git a/features/steps/test_files/shp-inline-shape-access.docx b/features/steps/test_files/shp-inline-shape-access.docx
