Refactored the template contexts.

- Changed `GroupedCommit` to `GroupingContext`
- Added `ChangelogContext` as a root context for templates.

Author: coordt

generate_changelog/context.py

@@ -1,12 +1,13 @@
-"""Context definitions."""
-from typing import List, Optional, Tuple
+"""Context definitions used in templates."""
+from typing import Callable, List, Optional, Tuple
 
 import collections
 import datetime
 import re
 from dataclasses import dataclass, field
 
-from generate_changelog.configuration import get_config
+from generate_changelog.configuration import Configuration, get_config
+from generate_changelog.utilities import diff_index
 
 
 @dataclass
@@ -87,7 +88,7 @@ def author_names(self) -> list:
 
 
 @dataclass
-class GroupedCommit:
+class GroupingContext:
     """A combination of a tuple of the sorted values and a list of the CommitContexts in that group."""
 
     grouping: Tuple[str]
@@ -113,8 +114,49 @@ class VersionContext:
     tagger: Optional[str] = None
     """The name and email of the person who tagged this version in `name <email@ex.com>` format."""
 
-    grouped_commits: List[GroupedCommit] = field(default_factory=list)
+    grouped_commits: List[GroupingContext] = field(default_factory=list)
     """The sections that group the commits in this version."""
 
     metadata: dict = field(default_factory=dict)
     """Metadata for this version parsed from commits."""
+
+
+@dataclass
+class ChangelogContext:
+    """The primary context used when rendering a changelog."""
+
+    config: Configuration
+    """The changelog generation configuration."""
+
+    versions: List[VersionContext] = field(default_factory=list)
+    """The version contexts to render in the changelog."""
+
+    # Fields generated from the configuration post init
+
+    unreleased_label: str = field(init=False)
+    """The configured label used as the version title of the changes since the last valid tag."""
+
+    valid_author_tokens: List[str] = field(init=False, default_factory=list)
+    """The configured tokens in git commit trailers that indicate authorship."""
+
+    group_by: list[str] = field(init=False, default_factory=list)
+    """The configured grouping aspects for commits within a version."""
+
+    group_depth: int = field(init=False)
+    """The number of levels version commits are grouped by."""
+
+    diff_index: Callable = field(init=False)
+
+    def __post_init__(self):
+        self.unreleased_label = self.config.unreleased_label
+        self.valid_author_tokens = self.config.valid_author_tokens
+        self.group_by = self.config.group_by
+        self.group_depth = len(self.config.group_by)
+        self.diff_index = diff_index
+
+        for var, val in self.config.rendered_variables.items():
+            setattr(self, var, val)
+
+    def as_dict(self):
+        """Safely generate a dict version of this object."""
+        return self.__dict__

generate_changelog/templates/commit.md.jinja

@@ -1,7 +1,7 @@
 - {{ commit.summary }}
   {{ commit.body|indent(2, first=True) }}
   {% for key, val in commit.metadata["trailers"].items() %}
-  {% if key not in VALID_AUTHOR_TOKENS %}
+  {% if key not in valid_author_tokens %}
   **{{ key }}:** {{ val|join(", ") }}
 
   {% endif %}

generate_changelog/templating.py

@@ -10,10 +10,10 @@
 from generate_changelog import git_ops
 from generate_changelog.actions.metadata import MetadataCollector
 from generate_changelog.configuration import Configuration, get_config
-from generate_changelog.context import CommitContext, GroupedCommit, VersionContext
+from generate_changelog.context import ChangelogContext, CommitContext, GroupingContext, VersionContext
 from generate_changelog.pipeline import Action, pipeline_factory
 
-from .utilities import diff_index, resolve_name
+from .utilities import resolve_name
 
 
 def get_default_env(config: Optional[Configuration] = None):
@@ -163,7 +163,7 @@ def key_func(input_value) -> tuple:
         return tuple((i is not None, i) for i in input_value[0])
 
     sorted_groups = sorted(commit_groups.items(), key=key_func)
-    return [GroupedCommit(*item) for item in sorted_groups]
+    return [GroupingContext(*item) for item in sorted_groups]
 
 
 def render(repository: Repo, config: Configuration, starting_tag: Optional[str] = None) -> str:
@@ -179,18 +179,13 @@ def render(repository: Repo, config: Configuration, starting_tag: Optional[str]
         The full or partial changelog
     """
     version_context = get_context_from_tags(repository, config, starting_tag)
-    context = config.variables.copy()
-    context["versions"] = version_context
-    context["VALID_AUTHOR_TOKENS"] = config.valid_author_tokens
-    context["diff_index"] = diff_index
-    context["group_depth"] = len(config.group_by)
-
+    context = ChangelogContext(config=config, versions=version_context)
     if starting_tag:
         heading_str = get_default_env(config).get_template("heading.md.jinja").render()
-        versions_str = get_default_env(config).get_template("versions.md.jinja").render(context)
+        versions_str = get_default_env(config).get_template("versions.md.jinja").render(context.as_dict())
         return "\n".join([heading_str, versions_str])
 
-    return get_default_env(config).get_template("base.md.jinja").render(context)
+    return get_default_env(config).get_template("base.md.jinja").render(context.as_dict())
 
 
 def first_matching(actions: list, commit: CommitContext) -> str:

test/test_templating.py

@@ -2,17 +2,17 @@
 import datetime
 import textwrap
 from pathlib import Path
-from test import conftest
 
 import pytest
-from conftest import commit_factory
 from faker import Faker
 from pytest import param
 
 from generate_changelog import configuration, templating
 from generate_changelog.configuration import DEFAULT_COMMIT_CLASSIFIERS, get_default_config
 from generate_changelog.context import CommitContext
 
+from .conftest import commit_factory
+
 FIXTURES_DIR = Path(__file__).parent / "fixtures"
 fake = Faker()
 
@@ -40,7 +40,7 @@ def test_first_matching(string, expected):
 
 def test_commit_context():
     """CommitContexts should properly parse things."""
-    commit = conftest.commit_factory()
+    commit = commit_factory()
     context = CommitContext(
         sha=commit.hexsha,
         commit_datetime=commit.committed_datetime,
@@ -57,7 +57,7 @@ def test_commit_context():
 
 def test_commit_with_no_email():
     """A trailer without an email should still get parsed."""
-    commit = conftest.commit_factory()
+    commit = commit_factory()
     name_only = fake.name()
     context = CommitContext(
         sha=commit.hexsha,