Develop (#65)

fixed #59 fixed #60 fixed #61 fixed #62 fixed #63

Author: fleetingbytes

CHANGELOG.md

@@ -2,6 +2,22 @@
 
 <!-- towncrier release notes start -->
 
+## [1.0.1](https://github.com/Nagidal/hatch-semver/tree/1.0.1) - 2022-11-17
+
+
+### Documentation
+
+- Fixed typos and errors in the documentation [#59](https://github.com/Nagidal/hatch-semver/issues/59)
+- Set correct project homepage in `pyproject.toml`. It should be now linked from [PyPI](https://pypi.org/project/hatch-semver/). [#64](https://github.com/Nagidal/hatch-semver/issues/64)
+
+
+### Development Details
+
+- Set current date in `__about__.py` [#61](https://github.com/Nagidal/hatch-semver/issues/61)
+- Wrote a test for current date in `__about__.py` [#62](https://github.com/Nagidal/hatch-semver/issues/62)
+- Wrote a test for current version in the changelog [#63](https://github.com/Nagidal/hatch-semver/issues/63)
+
+
 ## [1.0.0](https://github.com/Nagidal/hatch-semver/tree/1.0.0) - 2022-11-17
 
 

docs/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 <!-- towncrier release notes start -->
 
+## [1.0.1](https://github.com/Nagidal/hatch-semver/tree/1.0.1) - 2022-11-17
+
+
+### Documentation
+
+- Fixed typos and errors in the documentation [#59](https://github.com/Nagidal/hatch-semver/issues/59)
+- Set correct project homepage in `pyproject.toml`. It should be now linked from [PyPI](https://pypi.org/project/hatch-semver/). [#64](https://github.com/Nagidal/hatch-semver/issues/64)
+
+
+### Development Details
+
+- Set current date in `__about__.py` [#61](https://github.com/Nagidal/hatch-semver/issues/61)
+- Wrote a test for current date in `__about__.py` [#62](https://github.com/Nagidal/hatch-semver/issues/62)
+- Wrote a test for current version in the changelog [#63](https://github.com/Nagidal/hatch-semver/issues/63)
+
+
 ## [1.0.0](https://github.com/Nagidal/hatch-semver/tree/1.0.0) - 2022-11-17
 
 

docs/user_guide/1-commands.md

@@ -152,13 +152,13 @@ Same as with pre-releases, this is prone to a [bug in python-semver][bug].
 | `1.0.0+fix-docs.2`     | `build=docs-fixed`  | `1.0.0+fix-docs.3` <sup>[bug][bug]</sup> |
 
 Build versions are all of the same precedence, so technically, a version bump does not occur.
-Normally, [bump-validation][validation] checks whether the resulting version is of the same precedence as the old one. 
+Normally, [bump-validation][validation] checks whether the resulting version is higher than the old one. 
 However, if all that changes is the build identifier, a version of equal precedence is sufficient to pass the validation. 
 
-| Old Version            | Command             | validate-bump | New Version          |
-| ---------------------- | ------------------- | ------------- | -------------------- |
+| Old Version            | Command             | validate-bump | New Version            |
+| ---------------------- | ------------------- | ------------- | ---------------------- |
 | `4.8.5-rc.2`           | `build=tracing`     | True          | `4.8.5-rc.2+tracing.1` |
-| `4.8.5-rc.2+tracing.2` | `4.8.5-rc.2+debug`  | True          | `4.8.5-rc.2+debug`   |
+| `4.8.5-rc.2+tracing.2` | `4.8.5-rc.2+debug`  | True          | `4.8.5-rc.2+debug`     |
 
 ### Development Build Shortcut
 
@@ -177,7 +177,7 @@ Similar to the [alpha and beta][ab-short] shortcuts, `dev` is not an alias, so d
 
 Similar to [python-semver's][python-semver] inability to bump alphanumeric pre-release identifiers, alphanumeric build identifiers will also not be bumped.
 The returned result is the exact same version.
-A ValidationError is not raised because when bumping or changing build identifiers equal precedece of the old and new version is sufficient.
+A ValidationError is not raised because when bumping or changing build identifiers, equal precedece of the old and new version is sufficient.
 
 | Old Version            | Command             | validate-bump | New Version          |
 | ---------------------- | ------------------- | ------------- | -------------------- |
@@ -189,7 +189,7 @@ You can chain commands together by comma like this: `<command1>,<command2>,<comm
 They are executed one by one in the specified sequence. Some straight-forward and most common examples of chained commands are presented in the [pre-release][chained-pre] section.
 
 The bump validation check is performed only after the last command is executed. 
-It is therefore OK to temporarily violate the version precedence rule for the intermediate versions as long as the last resulting version passes the validation agains the old version.
+It is therefore OK to temporarily violate the version precedence rule for the intermediate versions as long as the last resulting version passes the validation against the old version.
 
 | Old Version            | Command             | validate-bump | New Version          |
 | ---------------------- | ------------------- | ------------- | -------------------- |

docs/user_guide/2-migrating-to-semver.md

@@ -5,7 +5,7 @@ If you have used the hatch [standard][hatch_versioning] versioning scheme plugin
 
 ### Identical or Similar Behavior
 
-| Old version | command   | Standard Plugin     | Semver Plugin      |
+| Old version | Command   | Standard Plugin     | Semver Plugin      |
 | ----------- | --------- | ------------------- | ------------------ |
 | `1.0.0`     | `major`   | `2.0.0`             | `2.0.0`            |
 | `1.0.0`     | `minor`   | `1.1.0`             | `1.1.0`            |
@@ -17,15 +17,15 @@ If you have used the hatch [standard][hatch_versioning] versioning scheme plugin
 When bumping only the pre-release segment of a version which has not yet any pre-release segment, hatch-semver automatically bumps the patch version.
 It also automatically adds a purely numeric identifier *1* through which bumping becomes possible. Without a numeric identifier, this pre-release [could not be bumped][unbumpable].
 
-| Old version | command   | Standard Plugin     | Semver Plugin      | Comment                    |
+| Old version | Command   | Standard Plugin     | Semver Plugin      | Comment                    |
 | ----------- | -------   | ------------------- | ------------------ | -------------------------- |
 | `1.0.0`     | `alpha`   | `1.0.0a0`           | `1.0.1-alpha.1`    | patch version auto-bumped  |
 | `1.0.0`     | `beta`    | `1.1.0b0`           | `1.0.1-beta.1`     | patch version auto-bumped  |
-| `1.0.0`     | `rc`<br>`pre` | `1.1.0rc0`      | `1.0.1-rc.1`       | patch version auto-bumped  |
+| `1.0.0`     | `rc`      | `1.1.0rc0`          | `1.0.1-rc.1`       | patch version auto-bumped  |
 
-The patch segment of the [version core][bnf] is not bumped, if prerelease is bumped in a [chained command][chain] where a version core bump has occurred before. 
+The patch segment of the [version core][bnf] is not bumped, if pre-release is bumped in a [chained command][chain] where a version core bump has occurred before. 
 
-| Old version | command        | Standard Plugin | Semver Plugin   | Comment                        |
+| Old version | Command        | Standard Plugin | Semver Plugin   | Comment                        |
 | ----------- | -------------- | ----------------| --------------- | ------------------------------ |
 | `1.0.0`     | `patch,alpha`  | `1.0.1a0`       | `1.0.1-alpha.1` | patch version not auto-bumped  |
 | `1.0.0`     | `minor,beta`   | `1.1.0b0`       | `1.1.0-beta.1`  | patch version not auto-bumped  |
@@ -40,21 +40,21 @@ It performs a real bump *to the release version*.
 This normally goes along with a [validation][validation] check. 
 When you try to release version which is not a prerelease, this will raise a ValidationError.
 
-| Old version   | command   | validate-bump | Standard Plugin     | Semver Plugin      |
+| Old version   | Command   | validate-bump | Standard Plugin     | Semver Plugin      |
 | ------------- | --------- | ------------- | ------------------- | ------------------ |
-| `1.0.0`       | `release` | True          | `1.0.0`             | `ValueError`       |
+| `1.0.0`       | `release` | True          | `1.0.0`             | `ValidationError`  |
 | `1.0.0`       | `release` | False         | `1.0.0`             | `1.0.0`            |
-| `1.0.0+dev.1` | `release` | True          | `1.0.0`             | `ValueError`       |
+| `1.0.0+dev.1` | `release` | True          | `1.0.0`             | `ValidationError`  |
 | `1.0.0+dev.1` | `release` | False         | `1.0.0`             | `1.0.0`            |
 
 ### Unsupported Commands
 
 Hatch's [standard][hatch_versioning]'s versioning scheme's `rev`, `r`, `post` commands are not supported. 
 There is no concept of a revision or a post-release in [Semver][semver]. 
-However, with `build=post`, for instance you could accomplish add the build identifiers *post* and *1* which would be similar to a PEP 440 post-release.
+However, with `build=post`, for instance you could add the build identifiers *post* and *1* which would be similar to a PEP 440 post-release.
 Like in PEP 440, also in Semver build identifiers have the same precedence.
 
-The abbreviations `a`, `b`, and `c` for `alpha`, `beta`, `rc`, and `preview` are also not supported and will result in [python-semver][python-semver] throwing a `ValueError` with *... is not a valid SemVer string*. Hatch-semver actually uses `pre` as an alias for [prerelease][prerelease].
+The abbreviations `a`, `b`, and `c` for `alpha`, `beta`, `rc`, and `preview`,respectively, are also not supported and will result in [python-semver][python-semver] throwing a `ValueError` with *... is not a valid SemVer string*. Hatch-semver actually uses `pre` as an alias for [pre-release][prerelease].
 
 Semver allows custom identifiers in prereleases, so if you really wanted an `a0` pre-release, you could achieve it by bumping to a specific version, i.e. `hatch version 1.2.3-a0` although such alphanumeric identifiers [cannot be bumped][unbumpable] by [python-semver].
 Better go with `1.2.3-a.1` which could be bumped to `1.2.3-a.2`, `1.2.3-a.3` etc.

pyproject.toml

@@ -49,8 +49,10 @@ dynamic = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/Nagidal/hatch-semver"
+Homepage = "https://nagidal.github.io/hatch-semver/"
+Repository = "https://github.com/Nagidal/hatch-semver"
 Issues = "https://github.com/Nagidal/hatch-semver/issues"
+PyPI = "https://pypi.org/project/hatch-semver/"
 
 [project.entry-points.hatch]
 semver = "hatch_semver.plugin.hooks"

src/hatch_semver/__about__.py

@@ -7,5 +7,5 @@
 __author_email__ = "[email protected]"
 __maintainer__ = __author__
 __maintainer_email__ = __author_email__
-__release_date__ = date(year=2022, month=11, day=13)
-__version__ = "1.0.0"
+__release_date__ = date(year=2022, month=11, day=17)
+__version__ = "1.0.1"

tests/conftest.py

@@ -8,8 +8,11 @@
 from hatch.utils.fs import Path, temp_directory
 
 collect_ignore = [
-    # "test_semver_scheme.py",
+    # "test_about.py",
     # "test_bump_instruction.py",
+    # "test_changelog.py",
+    # "test_hooks.py",
+    # "test_semver_scheme.py",
 ]
 
 

tests/test_about.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+
+import datetime
+
+import hatch_semver.__about__ as about
+
+
+def test_date():
+    release_date = about.__release_date__
+    assert isinstance(
+        release_date, datetime.date
+    ), "__release_date__ must be instance of datetime.date"
+    today = datetime.datetime.today()
+    assert release_date.year == today.year, "date.year in `__about__.py` is not current"
+    assert release_date.month == today.month, "date.month in `__about__.py` is not current"
+    assert release_date.day == today.day, "date.day in `__about__.py` is not current"
+
+
+def test_strings():
+    for text in (
+        about.__author__,
+        about.__author_email__,
+        about.__maintainer__,
+        about.__maintainer_email__,
+    ):
+        assert text
+        assert isinstance(text, str)
+
+
+def test_emails():
+    for mail in (
+        about.__author_email__,
+        about.__maintainer_email__,
+    ):
+        assert "@" in mail

tests/test_changelog.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+
+
+import re
+from pathlib import Path
+
+import pytest
+
+import hatch_semver.__about__ as about
+
+
+@pytest.fixture
+def changelog_files():
+    with open(
+        Path(__file__).parent.parent.absolute() / "CHANGELOG.md", encoding="utf-8"
+    ) as root_changelog, open(
+        Path(__file__).parent.parent.absolute() / "docs" / "CHANGELOG.md", encoding="utf-8"
+    ) as docs_changelog:
+        yield root_changelog, docs_changelog
+
+
+semver_re = re.compile(
+    r"(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?"
+)
+""" regex adapted from https://semver.org/ (just ditched the start and end of the string)"""
+
+
+def test_current_version_in_changelog(changelog_files):
+    """
+    Reads lines from the changelog until it encounters one which starts with
+    a heading level 2 (`## `) what should follow is a link to the current version in
+    Markdown syntax, e.g. `[1.0.0](https://...)`.
+    then it tries to get a match for the semver regex and compares it to the version
+    set in __about__.py
+    """
+    for file in changelog_files:
+        found_at_least_one_heading_line = False
+        while not (line := file.readline()).startswith("## "):
+            continue
+        else:
+            found_at_least_one_heading_line = True
+            match = semver_re.search(line)
+            assert match, "Did not find any Semver version in the first level 2 heading"
+            version_in_changelog = match.group(0)
+            assert (
+                version_in_changelog == about.__version__
+            ), f"Current version is not at the top of the changelog {file.name}"
+        assert found_at_least_one_heading_line, f"Did not find any level 2 heading in {file.name}"