GH28: Switch semver string to semver info (#29)

Author: award28

CHANGELOG.md

@@ -8,8 +8,21 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+<!-- BEGIN RELEASE NOTES -->
 ### [Unreleased]
 
+### [0.6.0] - 2023-02-08
+
+#### Changed
+- Pattern recognition of partitioned sections within the changelog file.
+- Semantic Version strings with old semver API to use the new semver.VersionInfo class.
+
+#### Removed
+- The LINKS section of the changelog file.
+
+#### Fixed
+- Incomplete semantic version parsing. Prerelease and Build sections are now allowed.
+
 ### [0.5.0] - 2023-02-04
 
 #### Added
@@ -64,10 +77,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `unreleased` command, with unreleased subcommands.
 - `unreleased content`, which lists the unreleased content.
 - `unreleased add`, which allows inline or prompted adding of unreleased changes.
-
-### [LINKS]
-
-[Unreleased]: https://github.com/award28/changelogger/compare/0.5.0...HEAD
+<!-- END RELEASE NOTES -->
+<!-- BEGIN LINKS -->
+[Unreleased]: https://github.com/award28/changelogger/compare/0.6.0...HEAD
+[0.6.0]: https://github.com/award28/changelogger/compare/0.5.0...0.6.0
 [0.5.0]: https://github.com/award28/changelogger/compare/0.4.0...0.5.0
 [0.4.0]: https://github.com/award28/changelogger/compare/0.3.4...0.4.0
 [0.3.4]: https://github.com/award28/changelogger/compare/0.3.3...0.3.4
@@ -78,3 +91,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.2.1]: https://github.com/award28/changelogger/compare/0.2.0...0.2.1
 [0.2.0]: https://github.com/award28/changelogger/compare/0.1.0...0.2.0
 [0.1.0]: https://github.com/award28/changelogger/commit/fc688488620df4fe014c9d1b55782b75a674fa15
+<!-- END LINKS -->

changelogger/app/manage/commands/check.py

@@ -35,15 +35,15 @@ def _check() -> None:
 
     # Validate all release notes are parseable for all versions
     # Point of Failure 1
-    changelog_versions = ["Unreleased", *all_versions, "LINKS"]
-    for version, prev_version in zip(
+    changelog_versions = ["Unreleased", *all_versions, None]
+    for new_version, old_version in zip(
         changelog_versions, changelog_versions[1:]
     ):
         try:
-            changelog.get_release_notes(version, prev_version)
-        except:
+            changelog.get_release_notes(new_version, old_version)  # type: ignore
+        except Exception as e:
             raise ValidationException(
-                f"Failed to validate notes for version {version}"
+                f"Failed to validate notes for version {new_version}: {str(e)}."
             )
 
     # Validate there are links in the expected format for all versions

changelogger/app/manage/commands/content.py

@@ -3,22 +3,22 @@
 
 from changelogger import changelog
 from changelogger.exceptions import CommandException
+from changelogger.models.domain_models import VersionInfo
 
 
 def content(
     version: str,
     pretty: bool = True,
 ) -> None:
+    version_info = VersionInfo.parse(version)
     """Retrieves the changelog content for the specified version."""
     all_versions = changelog.get_all_versions()
-    if version not in all_versions:
+    if version_info not in all_versions:
         raise CommandException(f"Could not find version {version}.")
 
-    i = all_versions.index(version)
-    prev_version = (
-        all_versions[i + 1] if i + 1 < len(all_versions) else "LINKS"
-    )
-    release_notes = changelog.get_release_notes(version, prev_version)
+    i = all_versions.index(version_info)
+    prev_version = all_versions[i + 1] if i + 1 < len(all_versions) else None
+    release_notes = changelog.get_release_notes(version_info, prev_version)
 
     md = release_notes.markdown()
     if pretty:

changelogger/app/manage/commands/upgrade.py

@@ -25,8 +25,8 @@ def upgrade(
 ) -> None:
     """Upgrades all versioned files, as specified in the changelogger config file."""
     old_version = changelog.get_latest_version()
-    bump = getattr(semver, f"bump_{version_to_bump.value}")
-    new_version = bump(old_version)
+    bump = getattr(old_version, f"bump_{version_to_bump.value}")
+    new_version = bump()
 
     release_notes = changelog.get_release_notes("Unreleased", old_version)
     update = ChangelogUpdate(

changelogger/app/unreleased/commands/add.py

@@ -33,7 +33,7 @@ def add(
     release_notes = changelog.get_release_notes("Unreleased", topmost_version)
 
     update = ChangelogUpdate(
-        new_version="",
+        new_version=None,
         old_version=topmost_version,
         release_notes=release_notes,
     )

changelogger/changelog.py

@@ -1,72 +1,128 @@
 from pathlib import Path
+from typing import Literal
 
 from changelogger.conf import settings
 from changelogger.conf.models import VersionedFile
-from changelogger.exceptions import RollbackException, UpgradeException
-from changelogger.models.domain_models import ChangelogUpdate, ReleaseNotes
+from changelogger.exceptions import (
+    CommandException,
+    RollbackException,
+    UpgradeException,
+)
+from changelogger.models.domain_models import (
+    ChangelogUpdate,
+    ReleaseNotes,
+    VersionInfo,
+)
 from changelogger.templating import update_with_jinja
 from changelogger.utils import cached_compile
 
+CHANGELOG_PARTITION_RELEASE_NOTES = "RELEASE NOTES"
+CHANGELOG_PARTITION_LINKS = "LINKS"
 
-def get_all_links() -> dict[str, str]:
-    lines = settings.CHANGELOG_PATH.read_text().split("\n")
+
+def _get_changelog_parition(partition: str) -> str:
+    changelog_content = settings.CHANGELOG_PATH.read_text()
+
+    start_partition = f"<!-- BEGIN {partition} -->"
+    end_partition = f"<!-- END {partition} -->"
+    partition_re = cached_compile(
+        rf"{start_partition}([\s\S]*){end_partition}"
+    )
+
+    match = partition_re.search(changelog_content)
+    if not match:
+        raise CommandException(
+            f"Expected partition for `{partition}`; None found."
+        )
+    return match[1]
+
+
+def _get_release_notes_parition() -> str:
+    return _get_changelog_parition(CHANGELOG_PARTITION_RELEASE_NOTES)
+
+
+def _get_links_parition() -> str:
+    return _get_changelog_parition(CHANGELOG_PARTITION_LINKS)
+
+
+def get_all_links() -> dict[VersionInfo | str, str]:
+    lines = _get_links_parition().split("\n")
 
     links = {}
     for line in lines:
         match = cached_compile(
-            r"\[([\d.]+|Unreleased)]: (.*)",
+            r"\[(.*)]: (.*)",
         ).search(
             line,
         )
 
         if not match:
             continue
 
-        links[match[1]] = match[2]
+        version_str = match[1]
+        link = match[2]
 
-    return links
+        if version_str == "Unreleased":
+            links[version_str] = link
+            continue
+
+        match = VersionInfo._REGEX.fullmatch(version_str)
+        if not match:
+            continue
+
+        links[VersionInfo.parse(version_str)] = link
 
+    return links
 
-def get_all_versions() -> list[str]:
-    lines = settings.CHANGELOG_PATH.read_text().split("\n")
 
+def get_all_versions() -> list[VersionInfo]:
+    lines = _get_release_notes_parition().split("\n")
     versions = []
     for line in lines:
         match = cached_compile(
-            r"### \[([\d.]+)]",
+            r"### \[(.*)]",
         ).search(
             line,
         )
 
         if not match:
             continue
 
-        versions.append(match[1])
+        version_str = match[1]
+
+        match = VersionInfo._REGEX.fullmatch(version_str)
+        if not match:
+            continue
+
+        versions.append(VersionInfo.parse(version_str))
     return versions
 
 
-def get_sorted_versions() -> list[str]:
-    versions = get_all_versions()
-    sorted_versions = sorted(
-        (tuple(map(int, version.split("."))) for version in versions)
-    )
-    return [".".join(map(str, v)) for v in sorted_versions]
+def get_sorted_versions() -> list[VersionInfo]:
+    return sorted(get_all_versions())
 
 
-def get_latest_version() -> str:
+def get_latest_version() -> VersionInfo:
     versions = get_sorted_versions()
     if not versions:
         raise UpgradeException(f"This changelog has no versions currently.")
     return versions[-1]
 
 
-def get_release_notes(version: str, prev_version: str) -> ReleaseNotes:
-    version = version.replace(".", r"\.")
+def get_release_notes(
+    new_version: VersionInfo | Literal["Unreleased"],
+    old_version: VersionInfo | None,
+) -> ReleaseNotes:
+    new_version_pattern = str(new_version).replace(".", r"\.")
 
-    content = settings.CHANGELOG_PATH.read_text()
+    content = _get_release_notes_parition()
 
+    pattern = rf"### \[{new_version_pattern}\]( - \d+-\d+-\d+)?([\s\S]*)"
+    if old_version:
+        old_version_pattern = str(old_version).replace(".", r"\.")
+        pattern += rf"### \[{old_version_pattern}\]"
     match = cached_compile(
-        rf"### \[{version}\]( - \d+-\d+-\d+)?([\s\S]*)### \[{prev_version}\]",
+        pattern,
     ).search(
         content,
     )

changelogger/models/domain_models.py

@@ -1,6 +1,8 @@
 from enum import Enum
+from typing import Union
 
-from pydantic import BaseModel
+import semver
+from pydantic import BaseModel, validator
 
 
 class SemVerType(Enum):
@@ -53,7 +55,19 @@ def markdown(self) -> str:
         return "\n".join(s.lstrip() for s in md.split("\n"))
 
 
+class VersionInfo(semver.VersionInfo):
+    @classmethod
+    def __get_validators__(cls):
+        yield cls.validate
+
+    @validator("*")
+    def validate(cls, v: Union[str, "VersionInfo"]) -> "VersionInfo":
+        if isinstance(v, VersionInfo):
+            return v
+        return cls.parse(v)
+
+
 class ChangelogUpdate(BaseModel):
-    new_version: str
-    old_version: str
+    new_version: VersionInfo | None
+    old_version: VersionInfo | None
     release_notes: ReleaseNotes

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "changelogged"
-version = "0.5.0"
+version = "0.6.0"
 description = "Automated management of your CHANGELOG.md and other versioned files, following the principles of Keep a Changelog and Semantic Versioning."
 license = "MIT"
 authors = ["award28 <austin.ward@klaviyo.com>"]

tests/app/manage/commands/test_content.py

@@ -25,9 +25,7 @@ def mock_print(self):
         "version,prev_version,pretty",
         [
             (version, prev_version, pretty)
-            for version, prev_version in zip(
-                VERSIONS, VERSIONS[1:] + ["LINKS"]
-            )
+            for version, prev_version in zip(VERSIONS, VERSIONS[1:] + [None])
             for pretty in (True, False)
         ],
     )
@@ -68,7 +66,7 @@ def test_content_version_not_found(
         mock_changelog,
     ) -> None:
         mock_changelog.get_all_versions.side_effect = (self.VERSIONS,)
-        version = "VERSION_DNE"
+        version = "0.0.0"
         with pytest.raises(CommandException) as excinfo:
             content(version)
 

tests/app/manage/commands/test_upgrade.py

@@ -10,7 +10,7 @@
 )
 
 
-class TestManageContentCommand:
+class TestManageUpgradeCommand:
     VERSIONS = ["0.1.1", "0.2.0", "0.1.0"]
 
     @pytest.fixture