python-kacl 0.6.2__py3-none-any.whl → 0.6.4__py3-none-any.whl

kacl/__init__.py

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

kacl/document.py

@@ -665,6 +665,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
                         "ERROR: Could not determine project url. Update your config or run within a valid git repository"
                     )
 
+        host_url = host_url.removesuffix(".git")
+
         return LinkProvider(
             host_url=host_url,
             compare_versions_template=compare_versions_template,

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:

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:

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):
@@ -149,7 +149,7 @@ class KACLVersion(KACLElement):
                         line_number=self.line_number(),
                         start_character_pos=start_pos,
                         end_character_pos=end_pos,
-                        error_message=")Version is not a valid semantic version.",
+                        error_message="Version is not a valid semantic version.",
                     )
                 )
         return errors

{python_kacl-0.6.2.dist-info → python_kacl-0.6.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.6.2
+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
@@ -19,6 +19,17 @@ Requires-Dist: semver
 Requires-Dist: gitpython
 Requires-Dist: pyyaml
 Requires-Dist: jira
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # python-kacl
 

{python_kacl-0.6.2.dist-info → python_kacl-0.6.4.dist-info}/RECORD

@@ -1,26 +1,26 @@
-kacl/__init__.py,sha256=vqGuRh20S5vuEY83cWbWkhGIWtSBBdvK-Fw4Z_Bzjuk,644
+kacl/__init__.py,sha256=q8SmFU-sgBzWA5PVrCnpP_Bb1gmCSKi3grD6o4TcEmw,644
 kacl/__main__.py,sha256=cpulIGoFUJNN5ZW9oUoNN1PnBvrOyJ24xwtpf_yRwgQ,91
 kacl/changes.py,sha256=A0POz-xFMpFuq7nISnx_K75xOZOMmBuHq6EZ8NOQDsU,661
 kacl/config.py,sha256=Glw-1hRqS3AHpZ-2QRGzHRQ-TSLc1xtneb2MEATWFEQ,3966
-kacl/document.py,sha256=5QHR0-kkO-wvjwX6kaQC-NzGe13sVqdBThGa_V3XQLA,24687
+kacl/document.py,sha256=dzeYCIgLA1WzK04jeeCW_AYSOCampc9x2cAHdbnEMpY,24737
 kacl/element.py,sha256=OG02QI8ND5fJpBMceT6dbIHr4uX9gLxK_fPCsOvMDHI,416
 kacl/exception.py,sha256=MfOVpUvhcQtm10rSY__74-oLo445PG8mLFGJPPIfXH0,41
 kacl/jira_client.py,sha256=KPE94bZDkJFKw3okFsCgf2DjoyMlUUTMZKtQGKreVQY,989
-kacl/kacl_cli.py,sha256=fdTVlhjldQGBRhiSG5x9SnnwKTgysLxhqlkjx8BUSK8,19804
+kacl/kacl_cli.py,sha256=KeCT4DydkHjckt5sbTtTwp2BQf0RllXpBUwLj-G5-U0,19987
 kacl/link_provider.py,sha256=tgvMYhJe2ErH1m_qXMlQEacq9Cg_KGp_-sF03sVFP6E,1866
 kacl/parser.py,sha256=EUtRjgaW0beWVqiYaRJ9Rcf6jbuGoTgWzVBdOdUHnv8,2587
-kacl/serializer.py,sha256=4HU0G6ETbsvf6TbuRdhuNcuWFfifMT6jAEyhtJkAL8s,2734
+kacl/serializer.py,sha256=VkPuW06-ehaHsNRtskLJ7o-l3Ckgs8oONkgxceewrms,2851
 kacl/utils.py,sha256=bHiDDmjoYB868Bm732vNjpfML-6xcNQQqS7NQn_Sfm0,2824
 kacl/validation.py,sha256=b9r_5CyY6Cmi9BePh47IgZ3j64zdVsoB_fFvucieNbw,2125
-kacl/version.py,sha256=OooYgbCgH6p0fYPOlU_V-I1pwnCVgLSZ2uOg2gjaogw,9532
+kacl/version.py,sha256=IDYCWIIXzxdYyMptUAidMgf0SXJqoETFVJ8NVyKgA9A,9526
 kacl/config/kacl-default.yml,sha256=BdrQytOsx32_vXXBtR3VRp1-nzWrczNVc-gHuCGYuIA,1424
+python_kacl-0.6.4.dist-info/licenses/LICENSE,sha256=TRSJOIt7LZuMeZXFleJVL_LHczSxqi70HEiTLT-kI8Q,1075
 tests/__init__.py,sha256=dwb12vsojIwrtIgqwjc2fWhEVgVoiedUaVpZ7kusfY0,23
 tests/snapshot_directory.py,sha256=yH_ZpzJG5nA6F1ZxCrFPpbxBBON6bxSYO5OYZqKuzZA,1264
-tests/test_cli.py,sha256=Fc8DA_72cYyjXQm9AfJdAzz89D5zVJGInIxwIBhqrKA,14286
+tests/test_cli.py,sha256=C4dMCJo-lq6rs5euIJdM55Bvm9YGKot_a36FO8YCtWU,17006
 tests/test_kacl.py,sha256=7hxrBVnj2srkhJGVrfpt651QEItthq-iDntxGnEbt_g,15919
-python_kacl-0.6.2.dist-info/LICENSE,sha256=TRSJOIt7LZuMeZXFleJVL_LHczSxqi70HEiTLT-kI8Q,1075
-python_kacl-0.6.2.dist-info/METADATA,sha256=U0oSV6yMNH8pewfV9dwoQeq2DhZlF7fNnEIGuWEB3Lg,24089
-python_kacl-0.6.2.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-python_kacl-0.6.2.dist-info/entry_points.txt,sha256=8oCwuEyBEH-Z1M_xZIUePgfM7HfkYUAwcXdTPdrnwt4,49
-python_kacl-0.6.2.dist-info/top_level.txt,sha256=25gO0j-S3j_-DCptjHqVBlJi3tH_tiN8qyympi1E_Ys,11
-python_kacl-0.6.2.dist-info/RECORD,,
+python_kacl-0.6.4.dist-info/METADATA,sha256=hC3mJKWO71afeUGCM_hlHL7cRL1AVAGO7WZQ-c8_JGs,24325
+python_kacl-0.6.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_kacl-0.6.4.dist-info/entry_points.txt,sha256=8oCwuEyBEH-Z1M_xZIUePgfM7HfkYUAwcXdTPdrnwt4,49
+python_kacl-0.6.4.dist-info/top_level.txt,sha256=25gO0j-S3j_-DCptjHqVBlJi3tH_tiN8qyympi1E_Ys,11
+python_kacl-0.6.4.dist-info/RECORD,,

{python_kacl-0.6.2.dist-info → python_kacl-0.6.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

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)