DOP-908: Parser support for deprecated versions (#141)

* DOP-908: Parser support for deprecated versions

* DOP-908: Correct deprecated_versions table name

* DOP-908: Address PR feedback

* DOP-908: Address PR feedback

* DOP-908: Add test for missing deprecated versions

Author: mango-db

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Support for deprecated versions (DOP-908).
+
 ## [v0.4.3] - 2020-04-15
 
 ### Added

snooty/postprocess.py

@@ -170,6 +170,8 @@ def run(
     def generate_metadata(self) -> n.SerializedNode:
         document: Dict[str, SerializableType] = {}
         document["title"] = self.project_config.title
+        if self.project_config.deprecated_versions:
+            document["deprecated_versions"] = self.project_config.deprecated_versions
         # Update metadata document with key-value pairs defined in event parser
         document["slugToTitle"] = {
             k: [node.serialize() for node in v]

snooty/rstspec.toml

@@ -49,6 +49,8 @@ options.stub-columns = "nonnegative_integer"
 
 [directive."ecosystem:landing-page-tiles"]
 
+[directive."landing:deprecated-version-selector"]
+
 [directive.admonition]
 content_type = "block"
 argument_type = "string"
@@ -542,7 +544,6 @@ options.title = "string"
 options.image = ["path", "uri"]
 options.type = "string"
 
-
 [directive.youtube]
 help = "Embed a video from YouTube in your article"
 argument_type = "string"

snooty/test_postprocess.py

@@ -40,6 +40,13 @@ def test_slug_title_mapping(backend: Backend) -> None:
     assert slugToTitle["page4"][0]["value"] == "Skip includes"
 
 
+def test_deprecated_versions(backend: Backend) -> None:
+    assert backend.metadata["deprecated_versions"] == {
+        "manual": ["v2.2", "v2.4", "v2.6", "v3.0", "v3.2", "v3.4"],
+        "mms": ["v1.1", "v1.2", "v1.3"],
+    }
+
+
 def test_expand_includes(backend: Backend) -> None:
     page4_id = FileId("page4.txt")
     ast = backend.pages[page4_id].ast

snooty/test_project.py

@@ -173,6 +173,13 @@ def test_bad_project() -> None:
     assert isinstance(diagnostics[0], ConstantNotDeclared)
 
 
+def test_missing_deprecated_versions() -> None:
+    backend = Backend()
+    project = Project(Path("test_data/test_project"), backend, build_identifiers)
+    project.build()
+    assert "deprecated_versions" not in backend.metadata
+
+
 def test_not_a_project() -> None:
     backend = Backend()
     project = Project(Path("test_data/not_a_project"), backend, build_identifiers)

snooty/test_types.py

@@ -23,6 +23,7 @@ def test_project() -> None:
     project_config, project_diagnostics = ProjectConfig.open(Path(".").resolve())
     assert project_config.name == "unnamed"
     assert project_config.title == "untitled"
+    assert project_config.deprecated_versions == None
     assert len(project_diagnostics) == 0
 
 

snooty/types.py

@@ -377,6 +377,7 @@ class ProjectConfig:
     title: str = field(default="untitled")
     source: str = field(default="source")
     constants: Dict[str, object] = field(default_factory=dict)
+    deprecated_versions: Optional[Dict[str, List[str]]] = field(default=None)
     intersphinx: List[str] = field(default_factory=list)
     substitutions: Dict[str, str] = field(default_factory=dict)
     # substitution_nodes contains a parsed representation of the substitutions member, and is populated on Project initialization.

test_data/test_postprocessor/snooty.toml

@@ -8,3 +8,7 @@ global-write = "Global Writes"
 global-write-clusters = "Global *Clusters*"
 service = "Atlas"
 blank = ""
+
+[deprecated_versions]
+manual = ["v2.2", "v2.4", "v2.6", "v3.0", "v3.2", "v3.4"]
+mms = ["v1.1", "v1.2", "v1.3"]