Skip to content

fix: address PR #34 code review feedback #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrepp merged 1 commit into from
Nov 17, 2025
+23 −37
Merged

fix: address PR #34 code review feedback #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
[![codecov](https://codecov.io/gh/jrepp/docuchango/branch/main/graph/badge.svg)](https://codecov.io/gh/jrepp/docuchango)
[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads/)
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
<!-- NOTE: Test count badge requires manual update after adding/removing tests -->
[![Tests](https://img.shields.io/badge/tests-628%20passing-brightgreen)](https://github.com/jrepp/docuchango/actions)

[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
[![Type checked: mypy](https://img.shields.io/badge/type%20checked-mypy-blue.svg)](http://mypy-lang.org/)
Expand Down
17 changes: 2 additions & 15 deletions docuchango/fixes/whitespace.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,11 @@ def normalize_empty_values(metadata: dict) -> tuple[dict, list[str]]:
return updated, messages


def ensure_required_fields(metadata: dict, doc_type: str | None) -> tuple[dict, list[str]]: # noqa: ARG001 - Reserved for document type-specific required fields
def ensure_required_fields(metadata: dict) -> tuple[dict, list[str]]:
"""Ensure required fields are present with defaults.

Args:
metadata: Frontmatter metadata dictionary
doc_type: Document type (adr, rfc, memo, prd) - reserved for future use

Returns:
Tuple of (updated_metadata, messages)
Expand Down Expand Up @@ -145,18 +144,6 @@ def fix_whitespace_and_fields(file_path: Path, dry_run: bool = False) -> tuple[b
if not post.metadata:
return False, ["No frontmatter found"]

# Determine document type from path
doc_type = None
path_str = str(file_path).lower()
if "/adr/" in path_str:
doc_type = "adr"
elif "/rfcs/" in path_str:
doc_type = "rfc"
elif "/memos/" in path_str:
doc_type = "memo"
elif "/prd/" in path_str:
doc_type = "prd"

original = post.metadata.copy()

# Apply fixes
Expand All @@ -171,7 +158,7 @@ def fix_whitespace_and_fields(file_path: Path, dry_run: bool = False) -> tuple[b
messages.extend(empty_msgs)

# 3. Ensure required fields
metadata, required_msgs = ensure_required_fields(metadata, doc_type)
metadata, required_msgs = ensure_required_fields(metadata)
messages.extend(required_msgs)

# Check if anything changed
Expand Down
29 changes: 14 additions & 15 deletions tests/test_whitespace_comprehensive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,8 @@ def test_uuid_collision_handling(self):
metadata1 = {"id": "test1"}
metadata2 = {"id": "test2"}

updated1, _ = ensure_required_fields(metadata1, "adr")
updated2, _ = ensure_required_fields(metadata2, "adr")
updated1, _ = ensure_required_fields(metadata1)
updated2, _ = ensure_required_fields(metadata2)

# UUIDs should be different
assert updated1["doc_uuid"] != updated2["doc_uuid"]
Expand All @@ -238,7 +238,7 @@ def test_uuid_format_validation(self):

metadata = {"id": "test"}

updated, _ = ensure_required_fields(metadata, "adr")
updated, _ = ensure_required_fields(metadata)

# Should be valid UUID
try:
Expand All @@ -255,7 +255,7 @@ def test_existing_empty_string_fields(self):
"project_id": "", # Should be set
}

updated, messages = ensure_required_fields(metadata, "adr")
updated, messages = ensure_required_fields(metadata)

# Empty tags left as-is (not our job to fix here)
assert updated["tags"] == ""
Expand All @@ -264,17 +264,16 @@ def test_existing_empty_string_fields(self):
# Empty project_id should be replaced
assert updated["project_id"] != ""

def test_different_doc_types(self):
"""Test required fields for different document types."""
for doc_type in ["adr", "rfc", "memo", "prd", None]:
metadata = {"id": "test"}
def test_required_fields_basic(self):
"""Test basic required fields are added."""
metadata = {"id": "test"}

updated, messages = ensure_required_fields(metadata, doc_type)
updated, messages = ensure_required_fields(metadata)

# All should get these fields
assert "tags" in updated
assert "doc_uuid" in updated
assert "project_id" in updated
# All should get these fields
assert "tags" in updated
assert "doc_uuid" in updated
assert "project_id" in updated

def test_preserving_extra_fields(self):
"""Test that extra fields are preserved."""
Expand All @@ -284,7 +283,7 @@ def test_preserving_extra_fields(self):
"another": 123,
}

updated, messages = ensure_required_fields(metadata, "adr")
updated, messages = ensure_required_fields(metadata)

# Custom fields should be preserved
assert updated["custom_field"] == "custom_value"
Expand All @@ -294,7 +293,7 @@ def test_very_large_metadata(self):
"""Test metadata with many existing fields."""
metadata = {f"field{i}": f"value{i}" for i in range(1000)}

updated, messages = ensure_required_fields(metadata, "adr")
updated, messages = ensure_required_fields(metadata)

# Should add required fields
assert "tags" in updated
Expand Down
10 changes: 5 additions & 5 deletions tests/test_whitespace_fixes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ def test_add_missing_tags(self):
"""Test adding missing tags field."""
metadata = {"id": "test"}

updated, messages = ensure_required_fields(metadata, "adr")
updated, messages = ensure_required_fields(metadata)

assert "tags" in updated
assert updated["tags"] == []
Expand All @@ -144,7 +144,7 @@ def test_add_missing_doc_uuid(self):
"""Test adding missing doc_uuid."""
metadata = {"id": "test"}

updated, messages = ensure_required_fields(metadata, "adr")
updated, messages = ensure_required_fields(metadata)

assert "doc_uuid" in updated
assert isinstance(updated["doc_uuid"], str)
Expand All @@ -155,7 +155,7 @@ def test_add_missing_project_id(self):
"""Test adding missing project_id."""
metadata = {"id": "test"}

updated, messages = ensure_required_fields(metadata, "adr")
updated, messages = ensure_required_fields(metadata)

assert "project_id" in updated
assert updated["project_id"] == "my-project"
Expand All @@ -165,7 +165,7 @@ def test_replace_empty_doc_uuid(self):
"""Test replacing empty doc_uuid."""
metadata = {"id": "test", "doc_uuid": ""}

updated, messages = ensure_required_fields(metadata, "adr")
updated, messages = ensure_required_fields(metadata)

assert updated["doc_uuid"] != ""
assert len(updated["doc_uuid"]) > 0
Expand All @@ -179,7 +179,7 @@ def test_preserve_existing_fields(self):
"project_id": "my-custom-project",
}

updated, messages = ensure_required_fields(metadata, "adr")
updated, messages = ensure_required_fields(metadata)

assert updated["tags"] == ["existing"]
assert updated["doc_uuid"] == "existing-uuid"
Expand Down
2 changes: 2 additions & 0 deletions uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.