python-kacl 0.7.4__tar.gz → 0.7.6__tar.gz

{python_kacl-0.7.4/python_kacl.egg-info → python_kacl-0.7.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.7.4
+Version: 0.7.6
 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.4 → python_kacl-0.7.6}/kacl/__init__.py

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

{python_kacl-0.7.4 → python_kacl-0.7.6}/kacl/document.py

@@ -74,20 +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)
-                        # 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
+        # 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

{python_kacl-0.7.4 → python_kacl-0.7.6}/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.4 → python_kacl-0.7.6}/kacl/version.py

@@ -105,6 +105,24 @@ class KACLVersion(KACLElement):
                 self.__sections[sec.title()] = sec
         return self.__sections
 
+    def duplicate_sections(self):
+        """Returns every section element whose title was already used earlier in this version."""
+        if not self.body().strip():
+            return []
+
+        seen = set()
+        duplicates = []
+        for section in KACLParser.parse_header(
+            text=self.body(),
+            start_depth=3,
+            end_depth=3,
+            line_offset=self.line_number(),
+        ):
+            if section.title() in seen:
+                duplicates.append(section)
+            seen.add(section.title())
+        return duplicates
+
     def changes(self, section):
         sections = self.sections()
         if sections and section in sections:
@@ -200,11 +218,23 @@ class KACLVersion(KACLElement):
         try:
             sections = self.sections()
         except ValueError as e:
-            errors.append(
-                KACLValidationError(
-                    error_message=str(e), line_number=self.line_number()
+            duplicates = self.duplicate_sections()
+            if not duplicates:
+                errors.append(
+                    KACLValidationError(
+                        error_message=str(e), line_number=self.line_number()
+                    )
+                )
+            for duplicate in duplicates:
+                errors.append(
+                    KACLValidationError(
+                        line=duplicate.raw(),
+                        line_number=duplicate.line_number(),
+                        error_message=f"Version '{self.version()}' has multiple sections with title '{duplicate.title()}'",
+                        start_character_pos=0,
+                        end_character_pos=len(duplicate.raw()),
+                    )
                 )
-            )
             return errors
 
         for title, element in sections.items():

{python_kacl-0.7.4 → python_kacl-0.7.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-kacl"
-version = "0.7.4"
+version = "0.7.6"
 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.4 → python_kacl-0.7.6/python_kacl.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.7.4
+Version: 0.7.6
 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.4 → python_kacl-0.7.6}/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.4 → python_kacl-0.7.6}/tests/test_kacl.py

@@ -657,3 +657,26 @@ def test_release_no_unreleased_multiple_versions(tmp_path):
         second_version_after = versions_after[1]
         # The link might be updated during auto-link, but shouldn't be broken
         assert second_version_after.link() is not None
+
+
+def test_validate_reports_every_duplicated_section():
+    changelog = kacl.parse(
+        "# Changelog\n\n"
+        "All notable changes to this project will be documented in this file.\n\n"
+        "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).\n\n"
+        "## [Unreleased]\n\n"
+        "### Added\n\n- a\n\n"
+        "### Changed\n\n- b\n\n"
+        "### Added\n\n- a again\n\n"
+        "### Changed\n\n- b again\n\n"
+    )
+    errors = [
+        e
+        for e in changelog.validate().errors()
+        if "multiple sections" in e.error_message()
+    ]
+    assert [(e.line_number(), e.line()) for e in errors] == [
+        (17, "### Added"),
+        (21, "### Changed"),
+    ]