add last version

Author: 3nids

docs/docs/api.md

@@ -2,6 +2,7 @@
 
 ::: pum.changelog.Changelog
 ::: pum.changelog.list_changelogs
+::: pum.changelog.last_version
 ::: pum.migration_parameter_definition.MigrationParameterDefintion
 ::: pum.config.PumConfig
 ::: pum.schema_migrations.SchemaMigrations

pum/changelog.py

@@ -7,7 +7,10 @@
 
 
 class Changelog:
-    """This class represent a changelog directory."""
+    """
+    This class represent a changelog directory.
+    The directory name is the version of the changelog.
+    """
 
     def __init__(self, dir):
         self.dir = dir
@@ -17,6 +20,30 @@ def __repr__(self):
         return f"<dir: {self.dir} (v: {self.version})>"
 
 
+def last_version(
+    config: PumConfig,
+    dir: str | Path = ".",
+    after_version: str | None = None,
+    before_version: str | None = None,
+) -> str | None:
+    """
+    Return the last version of the changelogs.
+    The changelogs are sorted by version.
+    If after_current_version is True, only the changelogs that are after the current version will be returned.
+    If after_current_version is False, all changelogs will be returned.
+    """
+    changelogs = list_changelogs(config, dir, after_version, before_version)
+    if not changelogs:
+        return None
+    if after_version:
+        changelogs = [c for c in changelogs if c.version > parse_version(after_version)]
+    if before_version:
+        changelogs = [c for c in changelogs if c.version < parse_version(before_version)]
+    if not changelogs:
+        return None
+    return changelogs[-1].version
+
+
 def list_changelogs(
     config: PumConfig,
     dir: str | Path = ".",

test/test_changelog.py

@@ -0,0 +1,71 @@
+import unittest
+from pathlib import Path
+
+
+from pum.config import PumConfig
+from pum.changelog import list_changelogs, last_version
+from packaging.version import parse as parse_version
+
+
+class TestChangelog(unittest.TestCase):
+    """
+    Test the class Upgrader.
+    """
+
+    def test_changelog(self):
+        cfg = PumConfig()
+        changelogs = list_changelogs(config=cfg, dir=Path("test") / "data" / "single_changelog")
+        self.assertEqual(len(changelogs), 1)
+        self.assertEqual(changelogs[0].version, parse_version("1.2.3"))
+
+        mulitple_dir = Path("test") / "data" / "multiple_changelogs"
+
+        changelogs = list_changelogs(config=cfg, dir=mulitple_dir)
+        self.assertEqual(len(changelogs), 4)
+        self.assertEqual(changelogs[0].version, parse_version("1.2.3"))
+        self.assertEqual(changelogs[1].version, parse_version("1.2.4"))
+        self.assertEqual(changelogs[2].version, parse_version("1.3.0"))
+        self.assertEqual(changelogs[3].version, parse_version("2.0.0"))
+
+        last_version_result = last_version(config=cfg, dir=mulitple_dir)
+        self.assertEqual(last_version_result, parse_version("2.0.0"))
+
+        last_version_result = last_version(
+            config=cfg,
+            dir=str(Path("test") / "data" / "multiple_changelogs"),
+            after_version="1.2.3",
+            before_version="1.3.0",
+        )
+        self.assertEqual(last_version_result, parse_version("1.2.4"))
+
+        last_version_result = last_version(
+            config=cfg,
+            dir=str(Path("test") / "data" / "multiple_changelogs"),
+            before_version="1.3.0",
+        )
+        self.assertEqual(last_version_result, parse_version("1.2.4"))
+
+        last_version_result = last_version(
+            config=cfg,
+            dir=str(Path("test") / "data" / "multiple_changelogs"),
+            before_version="1.2.3",
+        )
+        self.assertIsNone(last_version_result)
+
+        last_version_result = last_version(
+            config=cfg,
+            dir=str(Path("test") / "data" / "multiple_changelogs"),
+            after_version="1.2.3",
+        )
+        self.assertEqual(last_version_result, parse_version("2.0.0"))
+
+        last_version_result = last_version(
+            config=cfg,
+            dir=str(Path("test") / "data" / "multiple_changelogs"),
+            after_version="2.0.0",
+        )
+        self.assertIsNone(last_version_result)
+
+
+if __name__ == "__main__":
+    unittest.main()