DOP-1188: fix for labels starting with number

Signed-off-by: Andrew Aldridge <[email protected]>

Author: madelinezec

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Support labels beginning with numbers that contain underscores (DOP-1188)
+
 ## [v0.5.0] - 2020-07-08
 
 ### Added

snooty/parser.py

@@ -223,7 +223,7 @@ def dispatch_visit(self, node: docutils.nodes.Node) -> None:
                 self.diagnostics.append(InvalidURL(util.get_line(node)))
                 raise docutils.nodes.SkipNode()
 
-            node_id = node["ids"][0]
+            node_id = node["names"][0]
             children: Any = [n.TargetIdentifier((line,), [], [node_id])]
             refuri = node["refuri"] if "refuri" in node else None
             self.state.append(n.Target((line,), children, "std", "label", refuri))

snooty/test_parser.py

@@ -534,6 +534,40 @@ def test_rst_replacement() -> None:
     )
 
 
+def test_labels() -> None:
+    path = ROOT_PATH.joinpath(Path("test.rst"))
+    project_config = ProjectConfig(ROOT_PATH, "", source="./")
+    parser = rstparser.Parser(project_config, JSONVisitor)
+
+    # test label starting with a number
+    page, diagnostics = parse_rst(
+        parser,
+        path,
+        """
+:ref:`100_stacked_example`
+
+.. _100_stacked_example:
+""",
+    )
+    page.finish(diagnostics)
+    assert diagnostics == []
+
+    ast = page.ast
+    check_ast_testing_string(
+        ast,
+        """
+        <root>
+        <paragraph>
+                <ref_role domain="std" name="label" target="100_stacked_example"/>
+        </paragraph>
+        <target domain="std" name="label">
+                <target_identifier ids="['100_stacked_example']" />
+        </target>
+        </root>
+        """,
+    )
+
+
 def test_roles() -> None:
     path = ROOT_PATH.joinpath(Path("test.rst"))
     project_config = ProjectConfig(ROOT_PATH, "", source="./")

snooty/test_postprocess.py

@@ -140,11 +140,38 @@ def test_validate_ref_targets(backend: Backend) -> None:
         <literal><text>mongod</text></literal>
         </ref_role>""",
     )
+    # Assert that refs beginning with number and containing underscores, work
+    paragraph = ast.children[5]
+    assert isinstance(paragraph, n.Parent)
+    ref_role = paragraph.children[2]
+    check_ast_testing_string(
+        ref_role,
+        """<ref_role
+        domain="std"
+        name="label"
+        target="100_stacked_example"
+        fileid="index">
+        <text>100 Stacked Examples</text>
+        </ref_role>""",
+    )
 
+    paragraph = ast.children[6]
+    assert isinstance(paragraph, n.Parent)
+    ref_role = paragraph.children[2]
+    check_ast_testing_string(
+        ref_role,
+        """<ref_role
+        domain="std"
+        name="label"
+        target="z100_stacked_example"
+        fileid="index">
+        <text>Z100 Stacked Examples</text>
+        </ref_role>""",
+    )
     # Check that undeclared targets raise an error
     diagnostics = backend.diagnostics[page_id]
-    assert len(diagnostics) == 1
     assert isinstance(diagnostics[0], TargetNotFound)
+    assert isinstance(diagnostics[1], AmbiguousTarget)
 
 
 def test_role_explicit_title(backend: Backend) -> None:

test_data/test_postprocessor/source/index.txt

@@ -28,3 +28,21 @@ Testing Sibling Nodes
 
    /page1
    /page2
+
+.. _100_stacked_example:
+
+100 Stacked Examples
+---------------------
+
+.. method:: amethod(param1, param2)
+
+   Testing :ref:`<100_stacked_example>`.
+
+.. _z100_stacked_example:
+
+Z100 Stacked Examples
+---------------------
+
+.. method:: amethod(param1, param2)
+
+   Testing :ref:`<z100_stacked_example>`.

test_data/test_postprocessor/source/refrole.txt

@@ -15,3 +15,7 @@ requirements for sharding collections for |global-write|, see
 And this is a link to :method:`amethod`.
 
 And this is a link to :binary:`mongod`.
+
+|service| does not require developers, see :ref:`100_stacked_example`.
+
+|service| does require developers, see  :ref:`z100_stacked_example`.