feat(providers): add support for some TOML-based versions (PEP621, Poetry, Cargo)

Author: noirbizarre

commitizen/providers.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from typing import cast
+from pathlib import Path
+from typing import ClassVar, cast
 
 import importlib_metadata as metadata
+import tomlkit
 
 from commitizen.config.base_config import BaseConfig
 from commitizen.exceptions import VersionProviderUnknown
@@ -51,6 +53,75 @@ def set_version(self, version: str):
         self.config.set_key("version", version)
 
 
+class FileProvider(VersionProvider):
+    """
+    Base class for file-based version providers
+    """
+
+    filename: ClassVar[str]
+
+    @property
+    def file(self) -> Path:
+        return Path() / self.filename
+
+
+class TomlProvider(FileProvider):
+    """
+    Base class for TOML-based version providers
+    """
+
+    def get_version(self) -> str:
+        document = tomlkit.parse(self.file.read_text())
+        return self.get(document)
+
+    def set_version(self, version: str):
+        document = tomlkit.parse(self.file.read_text())
+        self.set(document, version)
+        self.file.write_text(tomlkit.dumps(document))
+
+    def get(self, document: tomlkit.TOMLDocument) -> str:
+        return document["project"]["version"]  # type: ignore
+
+    def set(self, document: tomlkit.TOMLDocument, version: str):
+        document["project"]["version"] = version  # type: ignore
+
+
+class Pep621Provider(TomlProvider):
+    """
+    PEP-621 version management
+    """
+
+    filename = "pyproject.toml"
+
+
+class PoetryProvider(TomlProvider):
+    """
+    Poetry version management
+    """
+
+    filename = "pyproject.toml"
+
+    def get(self, pyproject: tomlkit.TOMLDocument) -> str:
+        return pyproject["tool"]["poetry"]["version"]  # type: ignore
+
+    def set(self, pyproject: tomlkit.TOMLDocument, version: str):
+        pyproject["tool"]["poetry"]["version"] = version  # type: ignore
+
+
+class CargoProvider(TomlProvider):
+    """
+    Cargo version management
+    """
+
+    filename = "Cargo.toml"
+
+    def get(self, document: tomlkit.TOMLDocument) -> str:
+        return document["package"]["version"]  # type: ignore
+
+    def set(self, document: tomlkit.TOMLDocument, version: str):
+        document["package"]["version"] = version  # type: ignore
+
+
 def get_provider(config: BaseConfig) -> VersionProvider:
     """
     Get the version provider as defined in the configuration

docs/config.md

@@ -119,6 +119,15 @@ Commitizen can read and write version from different sources.
 By default, it use the `commitizen` one which is using the `version` field from the commitizen settings.
 But you can use any `commitizen.provider` entrypoint as value for `version_provider`.
 
+Commitizen provides some version providers for some well known formats:
+
+| name | description |
+| ---- | ----------- |
+| `commitizen` | Default version provider: Fetch and set version in commitizen config. |
+| `pep621` | Get and set version from `pyproject.toml` `project.version` field |
+| `poetry` | Get and set version from `pyproject.toml` `tool.poetry.version` field |
+| `cargo` | Get and set version from `Cargo.toml` `project.version` field |
+
 ### Custom version provider
 
 You can add you own version provider by extending `VersionProvider` and exposing it on the `commitizen.provider` entrypoint.

docs/faq.md

@@ -5,26 +5,19 @@ PEP621 establishes a `[project]` definition inside `pyproject.toml`
 ```toml
 [project]
 name = "spam"
-version = "2020.0.0"
+version = "2.5.1"
 ```
 
-Commitizen **won't** use the `project.version` as a source of truth because it's a
-tool aimed for any kind of project.
-
-If we were to use it, it would increase the complexity of the tool. Also why
-wouldn't we support other project files like `cargo.toml` or `package.json`?
-
-Instead of supporting all the different project files, you can use `version_files`
-inside `[tool.commitizen]`, and it will cheaply keep any of these project files in sync
+Commitizen provides a [`pep621` version provider](config.md#version-providers) to get and set version from this field.
+You just need to set the proper `version_provider` setting:
 
 ```toml
-[tool.commitizen]
+[project]
+name = "spam"
 version = "2.5.1"
-version_files = [
-    "pyproject.toml:^version",
-    "cargo.toml:^version",
-    "package.json:\"version\":"
-]
+
+[tool.commitizen]
+version_provider = "pep621"
 ```
 
 ## Why are `revert` and `chore` valid types in the check pattern of cz conventional_commits but not types we can select?

pyproject.toml

@@ -104,7 +104,10 @@ cz_jira = "commitizen.cz.jira:JiraSmartCz"
 cz_customize = "commitizen.cz.customize:CustomizeCommitsCz"
 
 [tool.poetry.plugins."commitizen.provider"]
+cargo = "commitizen.providers:CargoProvider"
 commitizen = "commitizen.providers:CommitizenProvider"
+pep621 = "commitizen.providers:Pep621Provider"
+poetry = "commitizen.providers:PoetryProvider"
 
 [tool.isort]
 profile = "black"

tests/test_version_providers.py

@@ -1,17 +1,34 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+import os
+from pathlib import Path
+from textwrap import dedent
+from typing import TYPE_CHECKING, Iterator
 
 import pytest
 
 from commitizen.config.base_config import BaseConfig
 from commitizen.exceptions import VersionProviderUnknown
-from commitizen.providers import CommitizenProvider, get_provider
+from commitizen.providers import (
+    CargoProvider,
+    CommitizenProvider,
+    Pep621Provider,
+    PoetryProvider,
+    get_provider,
+)
 
 if TYPE_CHECKING:
     from pytest_mock import MockerFixture
 
 
+@pytest.fixture
+def chdir(tmp_path: Path) -> Iterator[Path]:
+    cwd = Path()
+    os.chdir(tmp_path)
+    yield tmp_path
+    os.chdir(cwd)
+
+
 def test_default_version_provider_is_commitizen_config(config: BaseConfig):
     provider = get_provider(config)
 
@@ -33,3 +50,78 @@ def test_commitizen_provider(config: BaseConfig, mocker: MockerFixture):
 
     provider.set_version("43.1")
     mock.assert_called_once_with("version", "43.1")
+
+
+def test_pep621_provider(config: BaseConfig, chdir: Path):
+    pyproject_toml = chdir / "pyproject.toml"
+    pyproject_toml.write_text(
+        dedent(
+            """\
+            [project]
+            version = "0.1.0"
+            """
+        )
+    )
+
+    provider = Pep621Provider(config)
+
+    assert provider.get_version() == "0.1.0"
+
+    provider.set_version("43.1")
+
+    assert pyproject_toml.read_text() == dedent(
+        """\
+        [project]
+        version = "43.1"
+        """
+    )
+
+
+def test_poetry_provider(config: BaseConfig, chdir: Path):
+    pyproject_toml = chdir / "pyproject.toml"
+    pyproject_toml.write_text(
+        dedent(
+            """\
+            [tool.poetry]
+            version = "0.1.0"
+            """
+        )
+    )
+    config.settings["version_provider"] = "poetry"
+
+    provider = get_provider(config)
+    assert isinstance(provider, PoetryProvider)
+    assert provider.get_version() == "0.1.0"
+
+    provider.set_version("43.1")
+    assert pyproject_toml.read_text() == dedent(
+        """\
+        [tool.poetry]
+        version = "43.1"
+        """
+    )
+
+
+def test_cargo_provider(config: BaseConfig, chdir: Path):
+    cargo_toml = chdir / "Cargo.toml"
+    cargo_toml.write_text(
+        dedent(
+            """\
+            [package]
+            version = "0.1.0"
+            """
+        )
+    )
+    config.settings["version_provider"] = "cargo"
+
+    provider = get_provider(config)
+    assert isinstance(provider, CargoProvider)
+    assert provider.get_version() == "0.1.0"
+
+    provider.set_version("43.1")
+    assert cargo_toml.read_text() == dedent(
+        """\
+        [package]
+        version = "43.1"
+        """
+    )