Skip to content
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.

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

feat(providers): add rye version provider #1103

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 0 deletions commitizen/providers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from commitizen.providers.npm_provider import NpmProvider
from commitizen.providers.pep621_provider import Pep621Provider
from commitizen.providers.poetry_provider import PoetryProvider
from commitizen.providers.rye_provider import RyeProvider
from commitizen.providers.scm_provider import ScmProvider

__all__ = [
Expand All @@ -24,6 +25,7 @@
"NpmProvider",
"Pep621Provider",
"PoetryProvider",
"RyeProvider",
"ScmProvider",
]

Expand Down
20 changes: 20 additions & 0 deletions commitizen/providers/rye_provider.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
from __future__ import annotations

import tomlkit


from commitizen.providers.base_provider import TomlProvider


class RyeProvider(TomlProvider):
"""
Rye version management
"""

filename = "pyproject.toml"

def get(self, pyproject: tomlkit.TOMLDocument) -> str:
return pyproject["tool"]["rye"]["version"] # type: ignore

def set(self, pyproject: tomlkit.TOMLDocument, version: str):
pyproject["tool"]["rye"]["version"] = version # type: ignore
1 change: 1 addition & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,7 @@ Commitizen provides some version providers for some well known formats:
| `scm` | Fetch the version from git and does not need to set it back |
| `pep621` | Get and set version from `pyproject.toml` `project.version` field |
| `poetry` | Get and set version from `pyproject.toml` `tool.poetry.version` field |
| `rye` | Get and set version from `pyproject.toml` `tool.rye.version` field |
| `cargo` | Get and set version from `Cargo.toml` `project.version` field |
| `npm` | Get and set version from `package.json` `version` field, `package-lock.json` `version,packages.''.version` fields if the file exists, and `npm-shrinkwrap.json` `version,packages.''.version` fields if the file exists |
| `composer` | Get and set version from `composer.json` `project.version` field |
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ composer = "commitizen.providers:ComposerProvider"
npm = "commitizen.providers:NpmProvider"
pep621 = "commitizen.providers:Pep621Provider"
poetry = "commitizen.providers:PoetryProvider"
rye = "commitizen.providers:RyeProvider"
scm = "commitizen.providers:ScmProvider"

[tool.poetry.plugins."commitizen.scheme"]
Expand Down
2 changes: 1 addition & 1 deletion tests/providers/test_poetry_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"content, expected",
((POETRY_TOML, POETRY_EXPECTED),),
)
def test_cargo_provider(
def test_poetry_provider(
config: BaseConfig,
chdir: Path,
content: str,
Expand Down
45 changes: 45 additions & 0 deletions tests/providers/test_rye_provider.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
from __future__ import annotations

from pathlib import Path
from textwrap import dedent

import pytest

from commitizen.config.base_config import BaseConfig
from commitizen.providers import get_provider
from commitizen.providers.base_provider import VersionProvider
from commitizen.providers.rye_provider import RyeProvider


RYE_TOML = """\
[tool.rye]
version = "0.1.0"
"""

RYE_EXPECTED = """\
[tool.rye]
version = "42.1"
"""


@pytest.mark.parametrize(
"content, expected",
((RYE_TOML, RYE_EXPECTED),),
)
def test_rye_provider(
config: BaseConfig,
chdir: Path,
content: str,
expected: str,
):
filename = RyeProvider.filename
file = chdir / filename
file.write_text(dedent(content))
config.settings["version_provider"] = "rye"

provider: VersionProvider = get_provider(config)
assert isinstance(provider, RyeProvider)
assert provider.get_version() == "0.1.0"

provider.set_version("42.1")
assert file.read_text() == dedent(expected)
Loading