Corrections for changelog handling.

Author: idlesign

CHANGELOG.md

@@ -1,8 +1,8 @@
 # makeapp changelog
 
 
-# Unreleased
-* !! Big rewrite. Now uses up-to-date technologies.
+### Unreleased
+* !! Big rewrite. Now uses up-to-date conventions and technologies.
 * ++ Added virtual environment creation on project rollout.
 * ++ CLI. Added 'venv reset' command.
 * ++ CLI. Descriptions passed to 'change' command all go into a commit messages.

src/makeapp/app_templates/__default__/CHANGELOG.md

@@ -2,5 +2,4 @@
 
 
 ### Unreleased
-
 * ++ Basic functionality.

src/makeapp/apptools.py

@@ -164,7 +164,7 @@ def version_bump(self, increment: str = 'patch') -> tuple[int, ...]:
 class ChangelogData(DataContainer):
     """Information gathered from changelog file."""
 
-    PREFIXES = '!+-*'
+    change_markers = '!+-*'
     """Line prefixes denoting change nature.
     
     ! Important change/improvement/fix
@@ -173,36 +173,42 @@ class ChangelogData(DataContainer):
     * Minor change/improvement/fix
     
     """
+    change_marker_default = '*'
 
-    FILENAME_CHANGELOG = 'CHANGELOG.md'
-    UNRELEASED_STR = 'Unreleased'
+    filename = 'CHANGELOG.md'
+    marker_unreleased = 'Unreleased'
+
+    _prefix_version = '### '
+    _prefix_change = '* '
+    _offset_change = 1
 
     @classmethod
     def get(cls) -> 'ChangelogData':
         """Gathers information from a changelog."""
 
-        filepath = cls.FILENAME_CHANGELOG
+        filepath = Path(cls.filename)
 
-        LOG.debug(f'Getting changelog from `{os.path.basename(filepath)}` ...')
+        LOG.debug(f'Getting changelog from: {filepath.name} ...')
 
-        if not os.path.isfile(filepath):
+        if not filepath.is_file():
             raise ProjectorExeption('Changelog file not found.')
 
         changelog = FileHelper.read_file(filepath)
 
         if not changelog[0].startswith('# '):
             raise ProjectorExeption('Unexpected changelog file format.')
 
-        unreleased_str = cls.UNRELEASED_STR
+        unreleased_str = cls.marker_unreleased
+        prefix_version = cls._prefix_version
         version_line_idx = None
 
-        for supposed_line_idx in (3, 4, 5):
+        for supposed_line_idx in (2, 3, 4):
             line = changelog[supposed_line_idx].lstrip('# ')
             unreleased_entry_exists = line == unreleased_str
 
             if unreleased_entry_exists or line.startswith('v'):
                 version_line_idx = supposed_line_idx
-                LOG.info(f'Current version from changelog: `{line}`')
+                LOG.info(f'Current version from changelog: {line}.')
                 break
 
         if version_line_idx is None:
@@ -211,15 +217,10 @@ def get(cls) -> 'ChangelogData':
         if not unreleased_entry_exists:
             # Add `Unreleased` entry.
             changelog[version_line_idx:version_line_idx] = [
-                f'## {unreleased_str}',
-                '', ''
+                f'{prefix_version}{unreleased_str}',
+                ''
             ]
 
-        # Normalize.
-        if version_line_idx == 3:
-            changelog.insert(3, '')
-            version_line_idx = 4
-
         result = ChangelogData(
             file_helper=FileHelper(
                 filepath=filepath,
@@ -233,22 +234,22 @@ def get(cls) -> 'ChangelogData':
     def deduce_version_increment(self) -> str:
         """Deduces version increment chunk from a changelog.
 
-        Changelog bullets:
+        Changelog markers:
             * changed/fixed
             + new/feature
             - removed
 
         Deduction rules:
             By default `patch` chunk is incremented.
-            If any + entries `minor` is incremented.
+            If any `+` entries, `minor` is incremented.
 
         Returns: major, minor, patch
 
         """
         supposed_chunk = 'patch'
 
         for change in self.get_changes():
-            if change.startswith('* ++'):
+            if change.startswith(f'{self._prefix_change}++'):
                 supposed_chunk = 'minor'
                 break
         return supposed_chunk
@@ -261,14 +262,14 @@ def version_bump(self, new_version: tuple[int, ...]) -> str:
         :param new_version:
 
         """
-        version_str = f"v{'.'.join(map(str, new_version))}"
-        version_with_date = f"{version_str} [{datetime.now().strftime('%Y-%m-%d')}]"
+        version_num = f"v{'.'.join(map(str, new_version))}"
+        version_with_date = f"{self._prefix_version}{version_num} [{datetime.now().strftime('%Y-%m-%d')}]"
 
         replace = self.file_helper.line_replace
 
         replace(version_with_date)
 
-        return version_str
+        return version_num
 
     def add_change(self, description: str):
         """Adds change into changelog.
@@ -279,23 +280,23 @@ def add_change(self, description: str):
         if not description:
             return
 
-        bullet = description[0]
-        prefixes = self.PREFIXES
+        marker = description[0]
+        markers = self.change_markers
 
-        if bullet not in prefixes:
-            bullet = '*'
+        if marker not in markers:
+            marker = self.change_marker_default
 
-        description = description.lstrip(f' {prefixes}')
-        description = f'* {bullet * 2} {description}'
+        description = description.lstrip(f' {markers}')
+        description = f'{self._prefix_change}{marker * 2} {description}'
 
-        self.file_helper.insert(description, offset=2)
+        self.file_helper.insert(description, offset=self._offset_change)
 
     def get_changes(self) -> list[str]:
         """Returns a list of new version changes from a changelog."""
 
         changes = []
 
-        for line in self.file_helper.iter_after(offset=2):
+        for line in self.file_helper.iter_after(offset=self._offset_change):
 
             if not line.strip():
                 break
@@ -310,9 +311,9 @@ def get_version_summary(self) -> str:
         return '\n'.join(self.get_changes()).strip()
 
     def sort_version_changes(self):
-        """Sorts changes of latest version inplace."""
+        """Sorts changes of the latest version inplace."""
 
-        priorities = {prefix: priority for priority, prefix in enumerate(self.PREFIXES)}
+        priorities = {prefix: priority for priority, prefix in enumerate(self.change_markers)}
         priority_default = 3
 
         def sorter(line):
@@ -464,7 +465,7 @@ def add_change(self, descriptions: list[str] | tuple[str, ...] | str, *, stage_m
 
             changelog.write()
 
-            commit_message = f'{changelog.FILENAME_CHANGELOG} updated'
+            commit_message = f'{changelog.filename} updated'
 
             files_to_stage = [changelog.filepath]
 
@@ -473,7 +474,7 @@ def add_change(self, descriptions: list[str] | tuple[str, ...] | str, *, stage_m
 
                 # Set a description as a commit message.
                 commit_message = '\n'.join(
-                    description.strip(changelog.PREFIXES)
+                    description.strip(changelog.change_markers)
                     for description in descriptions
                 )
 

src/makeapp/helpers/files.py

@@ -9,7 +9,7 @@
 class FileHelper:
     """Encapsulates file related functions."""
 
-    def __init__(self, filepath, line_idx, contents):
+    def __init__(self, filepath: Path | str, line_idx, contents):
         self.filepath = filepath
         self.line_idx = line_idx
         self.contents = contents

src/makeapp/helpers/vcs.py

@@ -98,7 +98,7 @@ def add(self, filename: list[str] | str | list[Path] | Path = None):
         """
         filename = filename or []
         if isinstance(filename, list):
-            filename = ' '.join(filename)
+            filename = ' '.join(map(str, filename))
 
         filename = f'{filename}'.strip() or ''
 
@@ -172,7 +172,7 @@ def add_remote(self, address: str, *, alias: str = 'origin'):
 
         self.run_command(f'remote add {alias} {address}')
 
-    def add(self, filename: str = None):
+    def add(self, filename: Path | str = None):
         """Adds a file into a changelist.
 
         :param filename: If not provided all files in working tree are added.

tests/test_apptools.py

@@ -1,7 +1,7 @@
 from textwrap import dedent
 
+from makeapp.apptools import Project, ChangelogData
 from makeapp.helpers.vcs import VcsHelper
-from makeapp.apptools import Project
 
 
 def test_git(in_tmp_path, get_appmaker, assert_content, monkeypatch):
@@ -27,13 +27,7 @@ def test_git(in_tmp_path, get_appmaker, assert_content, monkeypatch):
     version, summary = project.get_release_info()
 
     assert version == 'v0.1.0'
-    assert summary == (
-        '* ++ add.\n'
-        '* ++ Basic functionality.\n'
-        '* ** change.\n'
-        '* ** fix1.\n'
-        '* ++ Basic functionality.'
-    )
+    assert summary == '* !! warn.\n* ++ add.\n* ++ Basic functionality.\n* ** change.\n* ** fix1.'
 
     project.release(version, summary)
 
@@ -72,3 +66,45 @@ def test_venv(in_tmp_path, get_appmaker, assert_content):
     assert_content(in_tmp_path / '.venv/pyvenv.cfg', [
         'version_info ='
     ])
+
+
+def test_changelog(in_tmp_path):
+
+    fchangelog = (in_tmp_path / ChangelogData.filename)
+    fchangelog.write_text(dedent("""    # {{ app_name }} changelog
+
+    ### Unreleased
+    * ++ Basic functionality.
+
+    """))
+
+    def load():
+        data_ = ChangelogData.get()
+        contents_ = data_.file_helper.contents
+        return data_, contents_
+
+    data, contents = load()
+    assert len(contents) == 5
+
+    assert data.deduce_version_increment() == 'minor'
+    data.sort_version_changes()
+
+    data.add_change('Some fix')
+    assert len(contents) == 6
+
+    assert data.get_version_summary() == '* ** Some fix\n* ++ Basic functionality.'
+
+    assert data.version_bump((1, 2, 3)) == 'v1.2.3'
+    assert '1.2.3' in contents[2]
+    data.write()
+
+    # another loop
+    data, contents = load()
+    assert len(contents) == 7  # Unreleased added
+    assert data.deduce_version_increment() == 'patch'
+
+    data.add_change('+ Some feature')
+    assert len(contents) == 8
+    assert data.deduce_version_increment() == 'minor'
+
+    assert data.get_version_summary() == '* ++ Some feature'