Add versions command (#31)

Author: award28

CHANGELOG.md

@@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <!-- BEGIN RELEASE NOTES -->
 ### [Unreleased]
 
+### [0.7.0] - 2023-03-01
+
+#### Added
+- Created the `manage versions` command
+
 ### [0.6.0] - 2023-02-08
 
 #### Changed
@@ -79,7 +84,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `unreleased add`, which allows inline or prompted adding of unreleased changes.
 <!-- END RELEASE NOTES -->
 <!-- BEGIN LINKS -->
-[Unreleased]: https://github.com/award28/changelogger/compare/0.6.0...HEAD
+[Unreleased]: https://github.com/award28/changelogger/compare/0.7.0...HEAD
+[0.7.0]: https://github.com/award28/changelogger/compare/0.6.0...0.7.0
 [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

changelogger/app/manage/__init__.py

@@ -3,11 +3,13 @@
 from changelogger.app.manage.commands.check import check
 from changelogger.app.manage.commands.content import content
 from changelogger.app.manage.commands.upgrade import upgrade
+from changelogger.app.manage.commands.versions import versions
 
 app = typer.Typer()
 app.command()(upgrade)
 app.command()(check)
 app.command()(content)
+app.command()(versions)
 
 
 @app.callback()

changelogger/app/manage/commands/versions.py

@@ -0,0 +1,21 @@
+from rich import print
+from typer import Option
+
+from changelogger import changelog
+
+
+def versions(
+    latest: bool = Option(
+        False, help="Gets the latest version in the changelog file"
+    ),
+    show_all: bool = Option(False, help="Get all versions."),
+    num_versions: int = Option(10, help="The number of versions to get."),
+) -> None:
+    """Retrieves the versions found in the changelog file."""
+    if latest:
+        print(changelog.get_latest_version())
+        return
+
+    all_versions = changelog.get_all_versions()
+    end = len(all_versions) if show_all else num_versions
+    print("\n".join(map(str, all_versions[:end])))

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "changelogged"
-version = "0.6.0"
+version = "0.7.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_versions.py

@@ -0,0 +1,51 @@
+from unittest.mock import MagicMock, patch
+
+import pytest
+import semver
+
+from changelogger.app.manage.commands.versions import versions
+
+
+class TestManageVersionsCommand:
+    VERSIONS = [semver.VersionInfo(v) for v in reversed(range(100))]
+
+    @pytest.fixture
+    def mock_changelog(self):
+        with patch(
+            "changelogger.app.manage.commands.versions.changelog"
+        ) as mock:
+            yield mock
+
+    @pytest.fixture
+    def mock_print(self):
+        with patch("changelogger.app.manage.commands.versions.print") as mock:
+            yield mock
+
+    def test_versions(
+        self,
+        mock_changelog: MagicMock,
+        mock_print: MagicMock,
+    ) -> None:
+        mock_changelog.get_all_versions.side_effect = (self.VERSIONS,)
+        versions(latest=False, show_all=False, num_versions=10)
+        mock_print.assert_called_once_with(
+            "\n".join(map(str, self.VERSIONS[:10]))
+        )
+
+    def test_versions_latest(
+        self,
+        mock_changelog: MagicMock,
+        mock_print: MagicMock,
+    ) -> None:
+        mock_changelog.get_latest_version.side_effect = (self.VERSIONS[0],)
+        versions(latest=True, show_all=False, num_versions=10)
+        mock_print.assert_called_once_with(self.VERSIONS[0])
+
+    def test_versions_show_all(
+        self,
+        mock_changelog: MagicMock,
+        mock_print: MagicMock,
+    ) -> None:
+        mock_changelog.get_all_versions.side_effect = (self.VERSIONS,)
+        versions(latest=False, show_all=True, num_versions=10)
+        mock_print.assert_called_once_with("\n".join(map(str, self.VERSIONS)))