Develop (#24)

Almost done, now for some documentation

Author: fleetingbytes

CHANGELOG.md

@@ -2,6 +2,27 @@
 
 <!-- towncrier release notes start -->
 
+## [0.1.0](https://github.com/Nagidal/hatch-semver/tree/0.1.0) - 2022-11-13
+
+
+### New Features
+
+- Added inline options for prerelease and build tokens [#23](https://github.com/Nagidal/hatch-semver/issues/23)
+
+
+### Bugfixes
+
+- Fixed undefined ValeError [#16](https://github.com/Nagidal/hatch-semver/issues/16)
+- Can bump prereleases now [#17](https://github.com/Nagidal/hatch-semver/issues/17)
+- Can bump builds now [#18](https://github.com/Nagidal/hatch-semver/issues/18)
+- Can update version to release [#22](https://github.com/Nagidal/hatch-semver/issues/22)
+
+
+### Development Details
+
+- Created tests [#19](https://github.com/Nagidal/hatch-semver/issues/19)
+
+
 ## [0.0.8](https://github.com/Nagidal/hatch-semver/tree/0.0.8) - 2022-11-10
 
 

pyproject.toml

@@ -11,7 +11,7 @@ readme = "README.md"
 license = "MIT"
 requires-python = ">=3.9"
 authors = [
-    { name = "Sven Siegmund", email = "sven.siegmund@iav.de" },
+    { name = "Sven Siegmund", email = "sven.siegmund@gmail.com" },
 ]
 
 keywords = [
@@ -40,7 +40,7 @@ classifiers = [
 
 dependencies = [
     "hatchling",
-    "semver",
+    "semver ~= 2.13.0",
 ]
 
 dynamic = [
@@ -67,8 +67,15 @@ dependencies = [
     "towncrier",
 ]
 
+[tool.hatch.envs.test]
+dependencies = [
+    "pytest",
+    "pytest-cov",
+    "hatch",
+]
+
 [tool.hatch.envs.default.scripts]
-cov = "pytest -v --cov-report=term-missing --cov-config=pyproject.toml --cov=src/hatch_semver --cov=tests"
+cov = "pytest -vx --cov-report=term-missing --cov-config=pyproject.toml --cov=src/hatch_semver --cov=tests"
 no-cov = "cov --no-cov"
 
 [tool.hatch.envs.style]
@@ -93,7 +100,7 @@ build = "pdoc --html --output-dir docs hatch-semver"
 serve = "pdoc --http : hatch-semver"
 
 [[tool.hatch.envs.test.matrix]]
-python = ["39", "310"]
+python = ["310"]
 
 [tool.coverage.run]
 branch = true
@@ -144,6 +151,6 @@ showcontent = true
 name = "Bugfixes"
 showcontent = true
 
-[tool.towncrier.fragment.detail]
+[tool.towncrier.fragment.unimportant]
 name = "Development Details"
 showcontent = true

src/hatch_semver/__about__.py

@@ -7,6 +7,6 @@
 __author_email__ = "[email protected]"
 __maintainer__ = __author__
 __maintainer_email__ = __author_email__
-__release_date__ = date(year=2022, month=11, day=10)
-__version__ = "0.0.8"
+__release_date__ = date(year=2022, month=11, day=13)
+__version__ = "0.1.0"
 

src/hatch_semver/bump_instruction.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python
+
+from dataclasses import dataclass, field, InitVar
+from typing import Optional, ClassVar
+
+
+@dataclass
+class BumpInstruction:
+    sep: ClassVar[str] = "="
+    acceptable_version_parts: ClassVar[tuple[str]] = (
+        "major",
+        "minor",
+        "patch",
+        "prerelease",
+        "build",
+        "release",
+    )
+    version_part: str = field(init=False)
+    token: Optional[str] = field(init=False)
+    is_specific: bool = field(init=False)
+    instruction: InitVar[str]
+
+    def __post_init__(self, instruction) -> None:
+        if self.sep not in instruction:
+            raw_version_part = instruction
+            raw_token = None
+        else:
+            raw_version_part, raw_token = instruction.split(self.sep, maxsplit=1)
+        self.version_part, self.token, self.is_specific = self.normalize_version_part(
+            raw_version_part, raw_token
+        )
+
+    @classmethod
+    def normalize_version_part(cls, part: str, token: str) -> tuple[str, str, bool]:
+        if part in ("pre", "prerelease", "pre-release", "rc"):
+            part = "prerelease"
+        elif part in ("micro", "fix"):
+            part = "patch"
+        elif part in ("alpha", "beta"):
+            if token:
+                raise ValueError(
+                    " ".join(
+                        (
+                            f"{part} version cannot be set to {token} directly.",
+                            f"Use 'prerelease={part}' instead",
+                        )
+                    )
+                )
+            token = part
+            part = "prerelease"
+        elif part in ("dev",):
+            if token:
+                raise ValueError(
+                    f"{part} version cannot be set to {token} directly. Use 'build={part}' instead"
+                )
+            token = part
+            part = "build"
+        if token:
+            if part in ("major", "minor", "patch", "release"):
+                raise ValueError(
+                    f"{part} version cannot be set to {token} specifically. Use {part} alone"
+                )
+        if part in cls.acceptable_version_parts:
+            specific = False
+        else:
+            specific = True
+        return part, token, specific

src/hatch_semver/semver_scheme.py

@@ -1,6 +1,11 @@
 #!/usr/bin/env python
 
 from hatchling.version.scheme.plugin.interface import VersionSchemeInterface
+from typing import Mapping
+from semver import VersionInfo
+from operator import ge, gt
+from copy import deepcopy
+from .bump_instruction import BumpInstruction
 
 
 class SemverScheme(VersionSchemeInterface):
@@ -12,33 +17,55 @@ class SemverScheme(VersionSchemeInterface):
     """
 
     PLUGIN_NAME = "semver"
+    INSTRUCTION_SEPARATOR = ","
 
-    def update(self, desired_version, original_version, version_data) -> str:
-        from semver import VersionInfo
-
-        original = VersionInfo.parse(original_version)
-        parts = desired_version.replace("micro", "patch").replace("fix", "patch").split(",")
-
-        for part in parts:
-            if part in ("major", "minor", "patch"):
-                next_version = getattr(original, "bump_" + part)()
-                original = next_version
-            elif part in ("post", "rev", "r"):
-                raise ValeError(f"Semver has no concept of a post-release. Use 'build' instead")
-            elif part == "dev":
-                raise ValeError(f"Semver has no concept of a dev-release. Use 'build' instead")
+    def update(self, desired_version: str, original_version: str, version_data: Mapping) -> str:
+        if not desired_version:
+            return original_version
+        original_version = VersionInfo.parse(original_version)
+        current_version = deepcopy(original_version)
+        instructions: str = desired_version
+        validate = self.config.get("validate-bump", True)
+        for instruction in instructions.split(self.INSTRUCTION_SEPARATOR):
+            bi = BumpInstruction(instruction)
+            last_bump_was_build = False
+            if bi.version_part == "build":
+                current_version = current_version.bump_build(token=bi.token)
+                last_bump_was_build = True
+            elif bi.version_part == "release":
+                current_version = current_version.finalize_version()
+            elif bi.is_specific:
+                current_version = VersionInfo.parse(bi.version_part)
             else:
-                if len(parts) > 1:
-                    raise ValueError(
-                        "Cannot specify multiple update operations with an explicit version"
-                    )
+                current_version = current_version.next_version(
+                    bi.version_part, prerelease_token=bi.token
+                )
+        if validate:
+            self.validate_bump(current_version, original_version, bumped_build=last_bump_was_build)
+        return current_version
 
-                next_version = VersionInfo.parse(part)
-                if self.config.get("validate-bump", True) and next_version <= original:
-                    raise ValueError(
-                        f"Version `{part}` is not higher than the original version `{original_version}`"
+    def validate_bump(
+        self, current_version: VersionInfo, original_version: VersionInfo, bumped_build: bool
+    ) -> None:
+        """
+        In Semver spec, all builds are equally ranked.
+        So for build bumps we validate only whether the current version is equal to the original one.
+        For other bumps we validate if the current version is higher than the original.
+        """
+        if bumped_build:
+            comparator = ge
+            relation = "at least as high as"
+        else:
+            comparator = gt
+            relation = "higher than"
+        if comparator(current_version, original_version):
+            return
+        else:
+            raise ValueError(
+                " ".join(
+                    (
+                        f"Version `{current_version}` is not {relation}",
+                        f"the original version `{original_version}`",
                     )
-                else:
-                    return str(next_version)
-
-        return str(original)
+                )
+            )

tests/conftest.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+
+from typing import Generator
+import os
+import pytest
+from hatch.config.constants import AppEnvVars, ConfigEnvVars, PublishEnvVars
+from hatch.utils.fs import Path, temp_directory
+
+
+collect_ignore = [
+        # "test_semver_scheme.py",
+        # "test_bump_instruction.py",
+]
+
+@pytest.fixture(scope='session', autouse=True)
+def isolation() -> Generator[Path, None, None]:
+    with temp_directory() as d:
+        data_dir = d / 'data'
+        data_dir.mkdir()
+        cache_dir = d / 'cache'
+        cache_dir.mkdir()
+
+        default_env_vars = {
+            AppEnvVars.NO_COLOR: '1',
+            ConfigEnvVars.DATA: str(data_dir),
+            ConfigEnvVars.CACHE: str(cache_dir),
+            PublishEnvVars.REPO: 'dev',
+            'HATCH_SELF_TESTING': 'true',
+            'GIT_AUTHOR_NAME': 'Foo Bar',
+            'GIT_AUTHOR_EMAIL': '[email protected]',
+            'COLUMNS': '80',
+            'LINES': '24',
+        }
+        with d.as_cwd(default_env_vars):
+            os.environ.pop(AppEnvVars.ENV_ACTIVE, None)
+            yield d
+
+