Commit 9b9829a

bearomorphismLee-W

authored and

committed

refactor(changelog): add get_next_tag_name_after_version and test, mark unused for get_smart_tag_range

1 parent 3ae6404 commit 9b9829aCopy full SHA for 9b9829a

File tree

2 files changed

+34

-8

lines changed

commitizen
- changelog.py
tests
- test_changelog.py

2 files changed

+34

-8

lines changed

`‎commitizen/changelog.py‎`

Lines changed: 16 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -276,6 +276,16 @@ def incremental_build(`
`276`	`276`	`return output_lines`
`277`	`277`
`278`	`278`
	`279`	`+def get_next_tag_name_after_version(tags: Iterable[GitTag], version: str) -> str \| None:`
	`280`	`+ it = iter(tag.name for tag in tags)`
	`281`	`+ for name in it:`
	`282`	`+ if name == version:`
	`283`	`+ return next(it, None)`
	`284`	`+`
	`285`	`+ raise NoCommitsFoundError(f"Could not find a valid revision range. {version=}")`
	`286`	`+`
	`287`	`+`
	`288`	`+# TODO: unused, deprecate this?`
`279`	`289`	`def get_smart_tag_range(`
`280`	`290`	`tags: Sequence[GitTag], newest: str, oldest: str \| None = None`
`281`	`291`	`) -> list[GitTag]:`
`@@ -303,7 +313,7 @@ def get_smart_tag_range(`
`303`	`313`
`304`	`314`
`305`	`315`	`def get_oldest_and_newest_rev(`
`306`		`- tags: Sequence[GitTag],`
	`316`	`+ tags: Iterable[GitTag],`
`307`	`317`	`version: str,`
`308`	`318`	`rules: TagRules,`
`309`	`319`	`) -> tuple[str \| None, str]:`
`@@ -326,15 +336,13 @@ def get_tag_name(v: str) -> str:`
`326`	`336`	`newest_tag_name = get_tag_name(newest_version)`
`327`	`337`	`oldest_tag_name = get_tag_name(oldest_version) if oldest_version else None`
`328`	`338`
`329`		`- tags_range = get_smart_tag_range(tags, newest_tag_name, oldest_tag_name)`
`330`		`- if not tags_range:`
`331`		`- raise NoCommitsFoundError("Could not find a valid revision range.")`
`332`		`-`
`333`		`- oldest_rev: str \| None = tags_range[-1].name`
	`339`	`+ oldest_rev = get_next_tag_name_after_version(`
	`340`	`+ tags, oldest_tag_name or newest_tag_name`
	`341`	`+ )`
`334`	`342`
`335`	`343`	`# Return None for oldest_rev if:`
`336`	`344`	`# 1. The oldest tag is the last tag in the list and matches the requested oldest tag`
`337`	`345`	`# 2. The oldest and the newest tag are the same`
`338`		`- if oldest_rev == oldest_tag_name==tags[-1].nameoroldest_rev==newest_tag_name:`
`339`		`- oldest_rev=None`
	`346`	`+ if oldest_rev == newest_tag_name:`
	`347`	`+ returnNone, newest_tag_name`
`340`	`348`	`return oldest_rev, newest_tag_name`

`‎tests/test_changelog.py‎`

Lines changed: 18 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1535,6 +1535,24 @@ def test_get_smart_tag_range_returns_an_extra_for_a_single_tag(tags):`
`1535`	`1535`	`assert 2 == len(res)`
`1536`	`1536`
`1537`	`1537`
	`1538`	`+def test_get_next_tag_name_after_version(tags):`
	`1539`	`+ # Test finding next tag after a version`
	`1540`	`+ next_tag_name = changelog.get_next_tag_name_after_version(tags, "v1.2.0")`
	`1541`	`+ assert next_tag_name == "v1.1.1"`
	`1542`	`+`
	`1543`	`+ next_tag_name = changelog.get_next_tag_name_after_version(tags, "v1.1.0")`
	`1544`	`+ assert next_tag_name == "v1.0.0"`
	`1545`	`+`
	`1546`	`+ # Test finding last tag when given version is last`
	`1547`	`+ last_tag_name = changelog.get_next_tag_name_after_version(tags, "v0.9.1")`
	`1548`	`+ assert last_tag_name is None`
	`1549`	`+`
	`1550`	`+ # Test error when version not found`
	`1551`	`+ with pytest.raises(changelog.NoCommitsFoundError) as exc_info:`
	`1552`	`+ changelog.get_next_tag_name_after_version(tags, "nonexistent")`
	`1553`	`+ assert "Could not find a valid revision range" in str(exc_info.value)`
	`1554`	`+`
	`1555`	`+`
`1538`	`1556`	`@dataclass`
`1539`	`1557`	`class TagDef:`
`1540`	`1558`	`name: str`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 9b9829a

File tree

2 files changed

2 files changed

`‎commitizen/changelog.py‎`

`‎tests/test_changelog.py‎`

0 commit comments