python-kacl 0.7.3__tar.gz → 0.7.5__tar.gz

{python_kacl-0.7.3/python_kacl.egg-info → python_kacl-0.7.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.7.3
+Version: 0.7.5
 Summary: Python module and CLI tool for validating and modifying Changelogs in "keep-a-changelog" format"
 Author-email: Matthias Schmieder <schmieder.matthias@gmail.com>
 License: MIT

{python_kacl-0.7.3 → python_kacl-0.7.5}/kacl/__init__.py

@@ -1,5 +1,5 @@
 # Version of the python-kacl package
-__version__ = "0.7.3"
+__version__ = "0.7.5"
 
 from kacl.document import KACLDocument
 from kacl.serializer import KACLMarkdownSerializer

{python_kacl-0.7.3 → python_kacl-0.7.5}/kacl/document.py

@@ -30,7 +30,7 @@ class KACLDocument:
         link_references=None,
         meta_data=None,
         file_path=None,
-        config=KACLConfig(),
+        config=None,
     ):
         self.__data = data
         self.__headers = headers if headers else []
@@ -39,7 +39,7 @@ class KACLDocument:
         if not self.__link_references:
             self.__link_references = dict()
         self.__meta_data = meta_data
-        self.config = config
+        self.config = config if config is not None else KACLConfig()
         self.stash = []
         self.file_path = file_path
 
@@ -74,17 +74,29 @@ class KACLDocument:
         if not os.path.isdir(local_stash_dir):
             return
 
-        # read all md files in the stash directory
-        for f in os.listdir(local_stash_dir):
-            if f.endswith(".md"):
-                md_file = os.path.join(local_stash_dir, f)
-                with open(md_file, "r") as fh:
-                    data = fh.read()
-                    try:
-                        doc = KACLDocument.parse(data, None)
-                        self.stash.append(doc)
-                    except Exception:
-                        continue
+        # read all md files in the stash directory (including legacy
+        # sub-directories created by branch names containing a slash)
+        for md_file in self.stash_files():
+            with open(md_file, "r") as fh:
+                data = fh.read()
+                try:
+                    doc = KACLDocument.parse(data, None)
+                    # stash documents must be validated against the same
+                    # config as the changelog they belong to
+                    doc.config = self.config
+                    self.stash.append(doc)
+                except Exception:
+                    continue
+
+    def stash_files(self):
+        """Returns the paths of all stash files, including nested ones."""
+        stash_dir = self._ensure_stash_directory()
+        files = []
+        for root, _, names in os.walk(stash_dir):
+            for name in sorted(names):
+                if name.endswith(".md"):
+                    files.append(os.path.join(root, name))
+        return sorted(files)
 
     def _ensure_stash_directory(self):
         # the stash needs always to be relative to the current file_path
@@ -205,7 +217,7 @@ class KACLDocument:
             try:
                 v0 = versions[i]
                 v1 = versions[i + 1]
-                if semver.compare(v0.version(), v1.version()) < 1:
+                if semver.Version.parse(v0.version()).compare(v1.version()) < 1:
                     validation.add_error(
                         line=v1.raw(),
                         line_number=v1.line_number(),
@@ -619,7 +631,12 @@ class KACLDocument:
                     versions[i].set_link(link_provider.unreleased_changes(**fargs))
                 else:
                     versions[i].set_link(link_provider.compare_versions(**fargs))
-            versions[-1].set_link(link_provider.initial_version(**fargs))
+            versions[-1].set_link(
+                link_provider.initial_version(
+                    version=versions[-1].version(),
+                    latest_version=self.current_version(),
+                )
+            )
         elif len(versions) == 1:
             fargs = {
                 "version": versions[0].version(),

{python_kacl-0.7.3 → python_kacl-0.7.5}/kacl/kacl_cli.py

@@ -545,11 +545,16 @@ def release(
 
         # delete all file in the stash directory
         stash_files = []
-        for f in os.listdir(kacl_changelog.stash_directory):
-            stash_file = os.path.join(kacl_changelog.stash_directory, f)
+        for stash_file in kacl_changelog.stash_files():
             os.remove(stash_file)
             stash_files.append(stash_file)
 
+        # remove sub-directories left empty (legacy branch names with slashes)
+        stash_dir = kacl_changelog.stash_directory
+        for root, _, _ in os.walk(stash_dir, topdown=False):
+            if root != stash_dir and not os.listdir(root):
+                os.rmdir(root)
+
         if commit or tag or kacl_config.git_create_commit or kacl_config.git_create_tag:
             vcs_context = {
                 "latest_version": latest_version,

{python_kacl-0.7.3 → python_kacl-0.7.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-kacl"
-version = "0.7.3"
+version = "0.7.5"
 description = "Python module and CLI tool for validating and modifying Changelogs in \"keep-a-changelog\" format\""
 readme = "README.md"
 requires-python = ">=3.9"

{python_kacl-0.7.3 → python_kacl-0.7.5/python_kacl.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.7.3
+Version: 0.7.5
 Summary: Python module and CLI tool for validating and modifying Changelogs in "keep-a-changelog" format"
 Author-email: Matthias Schmieder <schmieder.matthias@gmail.com>
 License: MIT

{python_kacl-0.7.3 → python_kacl-0.7.5}/tests/test_cli.py

@@ -20,6 +20,34 @@ def test_verify():
     assert result.exit_code == 11  # spawns 11 errors
 
 
+def test_verify_stash_with_custom_sections(tmp_path):
+    """Stash files must be validated against the loaded config, not the built-in defaults."""
+    runner = CliRunner()
+    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
+    changelog_file = os.path.join(resources_dir, "CHANGELOG.md")
+    stash_dir_local = os.path.join(resources_dir, "stash-custom-section")
+    config_file = os.path.join(resources_dir, "custom-sections-config.yml")
+
+    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
+        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
+        shutil.copytree(stash_dir_local, os.path.join(project_root_path, ".kacl_stash"))
+
+        # without the custom config the stashed "Chore" section is rejected
+        result = runner.invoke(
+            cli, ["-f", "CHANGELOG.md", "verify"], catch_exceptions=False
+        )
+        assert result.exit_code != 0, result.output
+        assert '"Chore" is not a valid section' in result.output
+
+        # with a config that allows "Chore" the stashed changes must validate
+        result = runner.invoke(
+            cli,
+            ["-c", config_file, "-f", "CHANGELOG.md", "verify"],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+
+
 def test_verify_invalid_duplicates():
     runner = CliRunner()
     result = runner.invoke(

{python_kacl-0.7.3 → python_kacl-0.7.5}/tests/test_cli_workflow.py

@@ -182,3 +182,44 @@ def test_integration_workflow_config(tmp_path, snapshot):
 
     assert result.exit_code == 0, result.output
     snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
+
+
+def test_release_with_nested_stash_directory(tmp_path):
+    runner = CliRunner()
+    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
+    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
+    config = os.path.join(resources_dir, "stash-config.yml")
+
+    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
+        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
+
+        # stash file for a branch like "refactor/foo" written by older versions
+        result = runner.invoke(
+            cli,
+            [
+                "-c",
+                config,
+                "-f",
+                "CHANGELOG.md",
+                "add",
+                "--stash",
+                "-m",
+                "Changed",
+                "x",
+            ],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+        stash_dir = os.path.join(project_root_path, ".kacl_stash")
+        flat = os.path.join(stash_dir, os.listdir(stash_dir)[0])
+        nested_dir = os.path.join(stash_dir, "refactor")
+        os.makedirs(nested_dir)
+        shutil.move(flat, os.path.join(nested_dir, "foo.md"))
+
+        result = runner.invoke(
+            cli,
+            ["-c", config, "-f", "CHANGELOG.md", "release", "99.0.0", "-m"],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+        assert os.listdir(stash_dir) == []

{python_kacl-0.7.3 → python_kacl-0.7.5}/tests/test_kacl.py

@@ -427,6 +427,30 @@ class TestKacl(TestCase):
             for v in versions:
                 self.assertIsNotNone(v.link())
 
+    def test_link_generation_initial_version(self):
+        changelog_file = os.path.join(
+            os.path.dirname(os.path.realpath(__file__)), "data", "CHANGELOG.md"
+        )
+        changelog = kacl.load(changelog_file)
+        host_url = "https://github.com/user/repository"
+        changelog.generate_links(host_url=host_url)
+
+        versions = changelog.versions()
+
+        # the oldest version has to link to its own tag, not the penultimate one
+        initial_version = versions[-1]
+        self.assertEqual(
+            initial_version.link(),
+            f"{host_url}/tree/{initial_version.version()}",
+        )
+
+        # every version in between has to compare against its predecessor
+        for i in range(1, len(versions) - 1):
+            self.assertEqual(
+                versions[i].link(),
+                f"{host_url}/compare/{versions[i + 1].version()}...{versions[i].version()}",
+            )
+
 
 def test_squash(tmp_path, snapshot):
     changelog_file = os.path.join(