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

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

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

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

{python_kacl-0.6.3 → python_kacl-0.6.4}/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.4}/kacl/serializer.py

@@ -11,9 +11,9 @@ 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)
@@ -21,20 +21,23 @@ class KACLMarkdownSerializer:
             data.append(self.__serialize_header(document.header()))
             data.append(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:

{python_kacl-0.6.3 → python_kacl-0.6.4}/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.4/python_kacl.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.6.3
+Version: 0.6.4
 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.4}/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.4"
 
 version = f"{version}{os.environ.get('PIP_VERSION_POSTFIX', '')}"
 

{python_kacl-0.6.3 → python_kacl-0.6.4}/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)