python-kacl 0.6.3__tar.gz → 0.6.5__tar.gz

{python_kacl-0.6.3/python_kacl.egg-info → python_kacl-0.6.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.6.3
+Version: 0.6.5
 Summary: Python module and CLI tool for validating and modifying Changelogs in "keep-a-changelog" format"
 Home-page: https://gitlab.com/schmieder.matthias/python-kacl.git
 Author: Matthias Schmieder

{python_kacl-0.6.3 → python_kacl-0.6.5}/kacl/__init__.py

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

{python_kacl-0.6.3 → python_kacl-0.6.5}/kacl/kacl_cli.py

@@ -177,7 +177,12 @@ def next(ctx, version):
 @cli.command()
 @click.pass_context
 @click.argument("version", type=str)
-def get(ctx, version):
+@click.option(
+    "--no-link",
+    is_flag=True,
+    help="This option suppresses a link, even if available.",
+)
+def get(ctx, version, no_link):
     """Returns a given version from the Changelog."""
     kacl_changelog = load_changelog(ctx)
 
@@ -185,6 +190,8 @@ def get(ctx, version):
     kacl_version = kacl_changelog.get(version)
 
     if kacl_version:
+        if no_link:
+            kacl_version.set_link(None)
         kacl_changelog_content = kacl.dump(kacl_version)
         click.echo(kacl_changelog_content)
     else:

{python_kacl-0.6.3 → python_kacl-0.6.5}/kacl/serializer.py

@@ -11,30 +11,37 @@ class KACLMarkdownSerializer:
         pass
 
     def serialize(self, document):
+        data = []
+        link_references = []
         if isinstance(document, KACLDocument):
-            data = []
-
             serialized_metadata = self.__serialize_metadata(document.metadata())
             if serialized_metadata:
                 data.extend(serialized_metadata)
 
             data.append(self.__serialize_header(document.header()))
-            data.append(document.header().body())
+            # check if the body starts with a newline. if not add one
+            if document.header().body().startswith("\n"):
+                data.append(document.header().body())
+            else:
+                data.append("\n" + document.header().body())
 
-            link_references = []
             for version in document.versions():
                 data.extend([self.__serialize_version(version), ""])
                 if version.has_link_reference():
                     link_references.append(self.__serialize_link_reference(version))
 
-            data.extend(link_references)
+        elif isinstance(document, KACLVersion):
+            data.extend([self.__serialize_version(document), ""])
 
-            if data[-1] != "":
-                data.append("")
+            if document.has_link_reference():
+                link_references.append(self.__serialize_link_reference(document))
 
-            return "\n".join(data)
-        elif isinstance(document, KACLVersion):
-            return self.__serialize_version(document)
+        data.extend(link_references)
+
+        if data[-1] != "":
+            data.append("")
+
+        return "\n".join(data)
 
     def __serialize_metadata(self, metadata):
         if not metadata:
@@ -64,11 +71,12 @@ class KACLMarkdownSerializer:
             return f"# {obj.title()}"
 
     def __serialize_version(self, obj):
-        lines = [self.__serialize_header(obj)]
+        lines = [self.__serialize_header(obj), ""]
         for title, changes in obj.sections().items():
             lines.extend(
                 [
                     self.__serialize_header(changes),
+                    "",
                     self.__serialize_list(changes.items()),
                     "",
                 ]

{python_kacl-0.6.3 → python_kacl-0.6.5}/kacl/version.py

@@ -47,9 +47,9 @@ class KACLVersion(KACLElement):
             return self.__link_reference.body()
 
     def set_link(self, link):
-        if isinstance(link, KACLElement):
+        if not link or isinstance(link, KACLElement):
             self.__link_reference = link
-        elif link is not None:
+        else:
             self.__link_reference = KACLElement(title=self.version(), body=link)
 
     def has_link_reference(self):

{python_kacl-0.6.3 → python_kacl-0.6.5/python_kacl.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.6.3
+Version: 0.6.5
 Summary: Python module and CLI tool for validating and modifying Changelogs in "keep-a-changelog" format"
 Home-page: https://gitlab.com/schmieder.matthias/python-kacl.git
 Author: Matthias Schmieder

{python_kacl-0.6.3 → python_kacl-0.6.5}/python_kacl.egg-info/SOURCES.txt

@@ -25,7 +25,5 @@ python_kacl.egg-info/entry_points.txt
 python_kacl.egg-info/not-zip-safe
 python_kacl.egg-info/requires.txt
 python_kacl.egg-info/top_level.txt
-tests/__init__.py
-tests/snapshot_directory.py
 tests/test_cli.py
 tests/test_kacl.py

{python_kacl-0.6.3 → python_kacl-0.6.5}/python_kacl.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
+kacl = kacl.kacl_cli:start
 kacl-cli = kacl.kacl_cli:start

python_kacl-0.6.5/python_kacl.egg-info/top_level.txt

@@ -0,0 +1 @@
+kacl

{python_kacl-0.6.3 → python_kacl-0.6.5}/setup.py

@@ -11,7 +11,7 @@ this_directory = path.abspath(path.dirname(__file__))
 with open(path.join(this_directory, "README.md"), encoding="utf-8") as f:
     long_description = f.read()
 
-version = "0.6.3"
+version = "0.6.5"
 
 version = f"{version}{os.environ.get('PIP_VERSION_POSTFIX', '')}"
 
@@ -33,9 +33,14 @@ setup(
     url="https://gitlab.com/schmieder.matthias/python-kacl.git",
     author="Matthias Schmieder",
     author_email="schmieder.matthias@gmail.com",
-    entry_points={"console_scripts": ["kacl-cli = kacl.kacl_cli:start"]},
+    entry_points={
+        "console_scripts": [
+            "kacl-cli = kacl.kacl_cli:start",
+            "kacl = kacl.kacl_cli:start",
+        ]
+    },
     license="MIT",
-    packages=find_packages(),
+    packages=find_packages(exclude=["tests", "tests.*"]),
     include_package_data=True,
     python_requires=">=3.9",
     install_requires=requirements,

{python_kacl-0.6.3 → python_kacl-0.6.5}/tests/test_cli.py

@@ -416,3 +416,77 @@ def test_add_comments(tmp_path):
             catch_exceptions=False,
         )
         assert result.exit_code == 0, result.output
+
+
+@freeze_time("2023-01-01")
+def test_get_no_link_available(tmp_path, snapshot):
+    runner = CliRunner()
+    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
+    changelog_file = os.path.join(resources_dir, "CHANGELOG_missing_link.md")
+
+    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
+        result = runner.invoke(
+            cli,
+            [
+                "-c",
+                os.path.join(resources_dir, "extension-config.yml"),
+                "-f",
+                changelog_file,
+                "get",
+                "2.0.0",
+            ],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+        with open(os.path.join(project_root_path, "output.md"), "w") as file:
+            file.write(result.output)
+        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
+
+
+def test_get_link_available(tmp_path, snapshot):
+    runner = CliRunner()
+    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
+    changelog_file = os.path.join(resources_dir, "CHANGELOG_missing_link.md")
+
+    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
+        result = runner.invoke(
+            cli,
+            [
+                "-c",
+                os.path.join(resources_dir, "extension-config.yml"),
+                "-f",
+                changelog_file,
+                "get",
+                "1.0.0",
+            ],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+        with open(os.path.join(project_root_path, "output.md"), "w") as file:
+            file.write(result.output)
+        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
+
+
+def test_get_suppress_available_link(tmp_path, snapshot):
+    runner = CliRunner()
+    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
+    changelog_file = os.path.join(resources_dir, "CHANGELOG_missing_link.md")
+
+    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
+        result = runner.invoke(
+            cli,
+            [
+                "-c",
+                os.path.join(resources_dir, "extension-config.yml"),
+                "-f",
+                changelog_file,
+                "get",
+                "--no-link",
+                "1.0.0",
+            ],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+        with open(os.path.join(project_root_path, "output.md"), "w") as file:
+            file.write(result.output)
+        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)

{python_kacl-0.6.3 → python_kacl-0.6.5}/tests/test_kacl.py

@@ -45,6 +45,15 @@ class TestKacl(TestCase):
         changelog_reference_lines = changelog_reference.split("\n")
 
         self.assertEqual(len(changelog_dump_lines), len(changelog_reference_lines))
+
+        for i in range(len(changelog_dump_lines)):
+            if changelog_dump_lines[i] != changelog_reference_lines[i]:
+                print(
+                    f"Line {i + 1} differs:\n"
+                    f"Dump: {changelog_dump_lines[i]}\n"
+                    f"Reference: {changelog_reference_lines[i]}"
+                )
+
         self.assertEqual(changelog_dump, changelog_reference)
 
     def test_add_change(self):
@@ -231,8 +240,8 @@ class TestKacl(TestCase):
     def test_release_with_increment(self):
         tests = {
             "major": "2.0.0",
-            "minor": "1.1.0",
-            "patch": "1.0.1",
+            "minor": "1.2.0",
+            "patch": "1.1.2",
         }
         changelog_file = os.path.join(
             os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
@@ -263,9 +272,9 @@ class TestKacl(TestCase):
     def test_release_with_increment_extension(self):
         tests = {
             "major": "2.0.0",
-            "minor": "1.1.0",
-            "patch": "1.0.1",
-            "post": "1.0.0-post.1",
+            "minor": "1.2.0",
+            "patch": "1.1.2",
+            "post": "1.1.1-post.1",
         }
         changelog_file = os.path.join(
             os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
@@ -285,9 +294,9 @@ class TestKacl(TestCase):
     def test_release_with_increment_extension_hotfix(self):
         tests = {
             "major": "2.0.0",
-            "minor": "1.1.0",
-            "patch": "1.0.1",
-            "post": "1.0.0-hotfix.1",
+            "minor": "1.2.0",
+            "patch": "1.1.2",
+            "post": "1.1.1-hotfix.1",
         }
         changelog_file = os.path.join(
             os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"

python_kacl-0.6.3/python_kacl.egg-info/top_level.txt

@@ -1,2 +0,0 @@
-kacl
-tests

python_kacl-0.6.3/tests/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.4.51"

python_kacl-0.6.3/tests/snapshot_directory.py

@@ -1,42 +0,0 @@
-import os
-from pathlib import Path
-
-
-def snapshot_directory(
-    snapshot,
-    directory_path,
-    dir_excludes=[".git"],
-    file_excludes=[],
-    sanitize_callbacks={},
-):
-    snapshot_dir = {}
-
-    for root, dirs, files in os.walk(directory_path, topdown=True):
-        dirs[:] = [d for d in dirs if d not in dir_excludes]
-
-        for file in files:
-            if file in file_excludes:
-                continue
-            current = snapshot_dir
-            parts = Path(root).relative_to(directory_path).parts
-            for part in parts:
-                current = current.setdefault(part, {})
-
-            file_path = os.path.join(root, f"{file}")
-            if __is_binary(file_path):
-                content = open(file_path, "rb").read()
-            else:
-                content = open(file_path, "r").read()
-
-            if file in sanitize_callbacks:
-                callback = sanitize_callbacks[file]
-                content = callback(content)
-
-            current[f"{file}.snap"] = content
-
-    snapshot.assert_match_dir(snapshot_dir, "snapshots")
-
-
-def __is_binary(file_path):
-    textchars = bytearray({7, 8, 9, 10, 12, 13, 27} | set(range(0x20, 0x100)) - {0x7F})
-    return bool(open(file_path, "rb").read(1024).translate(None, textchars))