style: add BaseSty._translate_special_case_names()

Steve Canny · Steve Canny · commit 8995fe392aef · 2015-02-08T00:01:14.000-08:00
* update api-add-heading feature to new style API and remove from WIP
diff --git a/docx/styles/style.py b/docx/styles/style.py
@@ -40,7 +40,10 @@ def name(self):
         """
         The UI name of this style.
         """
-        return self._element.name_val
+        name = self._element.name_val
+        if name is not None:
+            return self._translate_special_case_names(name)
+        return name
 
     @name.setter
     def name(self, value):
@@ -68,6 +71,26 @@ def type(self):
             return WD_STYLE_TYPE.PARAGRAPH
         return type
 
+    @staticmethod
+    def _translate_special_case_names(name):
+        """
+        Translate special-case style names to their English UI counterparts.
+        Some style names are stored differently than they appear in the UI,
+        with a leading lowercase letter, perhaps for legacy reasons.
+        """
+        return {
+            'caption':   'Caption',
+            'heading 1': 'Heading 1',
+            'heading 2': 'Heading 2',
+            'heading 3': 'Heading 3',
+            'heading 4': 'Heading 4',
+            'heading 5': 'Heading 5',
+            'heading 6': 'Heading 6',
+            'heading 7': 'Heading 7',
+            'heading 8': 'Heading 8',
+            'heading 9': 'Heading 9',
+        }.get(name, name)
+
 
 class _CharacterStyle(BaseStyle):
     """
diff --git a/features/api-add-heading.feature b/features/api-add-heading.feature
@@ -3,14 +3,12 @@ Feature: Add a section heading with text
   As a programmer using the basic python-docx API
   I need a method to add a heading with its text in a single step
 
-  @wip
   Scenario: Add a heading specifying only its text
     Given a document
      When I add a heading specifying only its text
-     Then the style of the last paragraph is 'Heading1'
+     Then the style of the last paragraph is 'Heading 1'
       And the last paragraph contains the heading text
 
-  @wip
   Scenario Outline: Add a heading specifying level
     Given a document
      When I add a heading specifying level=<heading level>
@@ -19,12 +17,12 @@ Feature: Add a section heading with text
    Examples: Heading level styles
      | heading level | paragraph style |
      |       0       | Title           |
-     |       1       | Heading1        |
-     |       2       | Heading2        |
-     |       3       | Heading3        |
-     |       4       | Heading4        |
-     |       5       | Heading5        |
-     |       6       | Heading6        |
-     |       7       | Heading7        |
-     |       8       | Heading8        |
-     |       9       | Heading9        |
+     |       1       | Heading 1       |
+     |       2       | Heading 2       |
+     |       3       | Heading 3       |
+     |       4       | Heading 4       |
+     |       5       | Heading 5       |
+     |       6       | Heading 6       |
+     |       7       | Heading 7       |
+     |       8       | Heading 8       |
+     |       9       | Heading 9       |
diff --git a/features/steps/api.py b/features/steps/api.py
@@ -152,11 +152,13 @@ def then_last_p_is_empty_paragraph_added(context):
     assert p.text == ''
 
 
-@then('the style of the last paragraph is \'{style}\'')
-def then_style_of_last_paragraph_is_style(context, style):
+@then('the style of the last paragraph is \'{style_name}\'')
+def then_the_style_of_the_last_paragraph_is_style(context, style_name):
     document = context.document
-    p = document.paragraphs[-1]
-    assert p.style == style
+    paragraph = document.paragraphs[-1]
+    assert paragraph.style.name == style_name, (
+        'got %s' % paragraph.style.name
+    )
 
 
 @then('the table style is \'{style}\'')
diff --git a/tests/styles/test_style.py b/tests/styles/test_style.py
@@ -141,8 +141,9 @@ def id_set_fixture(self, request):
         return style, new_value, expected_xml
 
     @pytest.fixture(params=[
-        ('w:style{w:type=table}',                      None),
-        ('w:style{w:type=table}/w:name{w:val=Boofar}', 'Boofar'),
+        ('w:style{w:type=table}',                         None),
+        ('w:style{w:type=table}/w:name{w:val=Boofar}',    'Boofar'),
+        ('w:style{w:type=table}/w:name{w:val=heading 1}', 'Heading 1'),
     ])
     def name_get_fixture(self, request):
         style_cxml, expected_value = request.param
