style: add _Style.name getter

Steve Canny · Steve Canny · commit 50af0f6d8f2c · 2015-02-08T00:01:14.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -87,6 +87,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:startOverride', CT_DecimalNumber)
 
 from .parts.styles import CT_Style, CT_Styles
+register_element_cls('w:name',   CT_String)
 register_element_cls('w:style',  CT_Style)
 register_element_cls('w:styles', CT_Styles)
 
diff --git a/docx/oxml/parts/styles.py b/docx/oxml/parts/styles.py
@@ -22,11 +22,22 @@ class CT_Style(BaseOxmlElement):
         'w:personalCompose', 'w:personalReply', 'w:rsid', 'w:pPr', 'w:rPr',
         'w:tblPr', 'w:trPr', 'w:tcPr', 'w:tblStylePr'
     )
+    name = ZeroOrOne('w:name', successors=_tag_seq[1:])
     pPr = ZeroOrOne('w:pPr', successors=_tag_seq[17:])
     type = OptionalAttribute('w:type', WD_STYLE_TYPE)
     styleId = OptionalAttribute('w:styleId', ST_String)
     del _tag_seq
 
+    @property
+    def name_val(self):
+        """
+        Value of ``<w:name>`` child or |None| if not present.
+        """
+        name = self.name
+        if name is None:
+            return None
+        return name.val
+
 
 class CT_Styles(BaseOxmlElement):
     """
diff --git a/docx/styles/style.py b/docx/styles/style.py
@@ -35,6 +35,13 @@ class BaseStyle(ElementProxy):
 
     __slots__ = ()
 
+    @property
+    def name(self):
+        """
+        The UI name of this style.
+        """
+        return self._element.name_val
+
     @property
     def style_id(self):
         """
diff --git a/features/sty-style-props.feature b/features/sty-style-props.feature
@@ -4,7 +4,6 @@ Feature: Get and set style properties
   I need a set of read/write style properties
 
 
-  @wip
   Scenario: Get name
     Given a style having a known name
      Then style.name is the known name
diff --git a/tests/styles/test_style.py b/tests/styles/test_style.py
@@ -108,6 +108,10 @@ def it_knows_its_type(self, type_get_fixture):
         style, expected_value = type_get_fixture
         assert style.type == expected_value
 
+    def it_knows_its_name(self, name_get_fixture):
+        style, expected_value = name_get_fixture
+        assert style.name == expected_value
+
     # fixture --------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -131,6 +135,15 @@ def id_set_fixture(self, request):
         expected_xml = xml(expected_style_cxml)
         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'),
+    ])
+    def name_get_fixture(self, request):
+        style_cxml, expected_value = request.param
+        style = BaseStyle(element(style_cxml))
+        return style, expected_value
+
     @pytest.fixture(params=[
         ('w:style',                   WD_STYLE_TYPE.PARAGRAPH),
         ('w:style{w:type=paragraph}', WD_STYLE_TYPE.PARAGRAPH),
