Renderer; sort versions and changes sections (#4)

Author: mdwint

.github/workflows/tests.yml

@@ -1,14 +1,19 @@
 name: Run tests
-
-on: [push, pull_request]
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+    paths-ignore:
+    - CHANGELOG.md
+    - README.md
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: ['3.7', '3.8', '3.9', '3.10']
-
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python

CHANGELOG.md

@@ -6,6 +6,18 @@ 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).
 
 
+## 0.2.0 - 2022-08-01
+
+### Added
+
+- Print output on success.
+
+### Changed
+
+- Sort version sections by version number.
+- Sort changes sections by type.
+
+
 ## 0.1.1 - 2022-08-01
 
 ### Fixed

ocdc/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.1"
+__version__ = "0.2.0"

ocdc/__main__.py

@@ -62,6 +62,9 @@ def format(args: argparse.Namespace) -> None:
             sys.exit(f"ERROR: {path} would be reformatted")
         else:
             path.write_text(result)
+            print(f"{path} was reformatted")
+    else:
+        print(f"{path} is well-formatted")
 
 
 def create_new(args: argparse.Namespace) -> None:

ocdc/renderer.py

@@ -1,6 +1,9 @@
 import datetime as dt
+import sys
 from textwrap import TextWrapper, indent
 
+from packaging.version import InvalidVersion, Version as ParsedVersion
+
 from . import ast
 
 MAX_WIDTH = 90
@@ -18,6 +21,19 @@ def wrap_item(item: ast.ListItem) -> str:
     return indent(item_wrapper.fill(item.text), item.level * INDENT)
 
 
+MAX_VERSION = ParsedVersion(str(sys.maxsize))
+
+
+def parse_version(number: str) -> ParsedVersion:
+    try:
+        return ParsedVersion(number)
+    except InvalidVersion:
+        return MAX_VERSION
+
+
+change_type_order = {t.value: i for i, t in enumerate(ast.ChangeType)}
+
+
 def render_markdown(c: ast.Changelog) -> str:
     text = ""
 
@@ -27,14 +43,17 @@ def render_markdown(c: ast.Changelog) -> str:
     if c.intro:
         text += wrap(c.intro) + "\n"
 
-    for v in c.versions:
+    version_order = {v.number: parse_version(v.number) for v in c.versions}
+
+    for v in sorted(c.versions, reverse=True, key=lambda v: version_order[v.number]):
         text += f"\n\n## {v.number}"
         if v.date:
             text += f" - {v.date}"
         text += "\n"
 
-        for type_, changes in v.changes.items():
+        for type_ in sorted(v.changes, key=lambda t: change_type_order[t]):
             text += f"\n### {type_}\n\n"
+            changes = v.changes[type_]
             for item in changes.items:
                 text += wrap_item(item) + "\n"
             if changes.footer:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ocdc"
-version = "0.1.1"
+version = "0.2.0"
 description = 'A changelog formatter for "people", neat freaks, and sloppy typists.'
 authors = ["Matteo De Wint <[email protected]>"]
 packages = [{ include = "ocdc" }]

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.1
+current_version = 0.2.0
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
 serialize = 
 	{major}.{minor}.{patch}

tests/conftest.py

@@ -1,8 +1,33 @@
 import os
 from contextlib import contextmanager
+from pathlib import Path
+from typing import Callable, Optional
 
 import pytest
 
+DUMP_EXPECTED_OUTPUTS = "--dump-expected-outputs"
+
+
+def pytest_addoption(parser):
+    g = parser.getgroup("ocdc")
+    g.addoption(
+        DUMP_EXPECTED_OUTPUTS,
+        action="store_true",
+        help="Dump expected outputs of test cases",
+    )
+
+
+@pytest.fixture(scope="session")
+def dump_expected_output(request) -> Optional[Callable[[Path, str], None]]:
+    if request.config.getoption(DUMP_EXPECTED_OUTPUTS):
+
+        def dump(path: Path, text: str) -> None:
+            path.write_text(text)
+            pytest.skip()
+
+        return dump
+    return None
+
 
 @pytest.fixture(scope="session")
 def chdir():

tests/data/basic.ast.json

@@ -4,13 +4,11 @@
   "versions": [
     {
       "number": "Unreleased",
-      "date": "",
       "changes": {
         "Added": {
           "items": [
             {
-              "text": "Not much, to be honest.",
-              "level": 0
+              "text": "Not much, to be honest."
             },
             {
               "text": "This item is indented.",
@@ -21,8 +19,7 @@
               "level": 1
             },
             {
-              "text": "Boom! Back to the left. These are links: [one] and [two].",
-              "level": 0
+              "text": "Boom! Back to the left. These are links: [one] and [two]."
             }
           ],
           "footer": "[one]: http://example.com/one\n[two]: http://example.com/two"
@@ -36,14 +33,15 @@
         "Added": {
           "items": [
             {
-              "text": "The first version, obviously. This line is going to be a long one. Let's hope it gets split at 90 characters.",
-              "level": 0
+              "text": "The first version, obviously. This line is going to be a long one. Let's hope it gets split at 90 characters."
             }
           ]
         },
         "Fixed": {
           "items": [
-            { "text": "Nothing at all. This line\nis split early.", "level": 0 }
+            {
+              "text": "Nothing at all. This line\nis split early."
+            }
           ]
         }
       }

tests/data/empty.ast.json

@@ -1,5 +1,3 @@
 {
-  "title": "",
-  "intro": "",
   "versions": []
 }