feat(providers): add dart_provider

closes: #1563

Author: TheAlbertDev

commitizen/commands/init.py

@@ -59,6 +59,10 @@ def is_rust_cargo(self) -> bool:
     def is_npm_package(self) -> bool:
         return os.path.isfile("package.json")
 
+    @property
+    def is_dart_package(self) -> bool:
+        return os.path.isfile("pubspec.yaml")
+
     @property
     def is_php_composer(self) -> bool:
         return os.path.isfile("composer.json")
@@ -234,6 +238,7 @@ def _ask_version_provider(self) -> str:
             "cargo": "cargo: Get and set version from Cargo.toml:project.version field",
             "composer": "composer: Get and set version from composer.json:project.version field",
             "npm": "npm: Get and set version from package.json:project.version field",
+            "dart": "dart: Get and set version from pubspec.yaml:version field",
             "pep621": "pep621: Get and set version from pyproject.toml:project.version field",
             "poetry": "poetry: Get and set version from pyproject.toml:tool.poetry.version field",
             "uv": "uv: Get and Get and set version from pyproject.toml and uv.lock",
@@ -252,6 +257,8 @@ def _ask_version_provider(self) -> str:
             default_val = "cargo"
         elif self.project_info.is_npm_package:
             default_val = "npm"
+        elif self.project_info.is_dart_package:
+            default_val = "dart"
         elif self.project_info.is_php_composer:
             default_val = "composer"
 

commitizen/providers/__init__.py

@@ -14,6 +14,7 @@
 from commitizen.providers.cargo_provider import CargoProvider
 from commitizen.providers.commitizen_provider import CommitizenProvider
 from commitizen.providers.composer_provider import ComposerProvider
+from commitizen.providers.dart_provider import DartProvider
 from commitizen.providers.npm_provider import NpmProvider
 from commitizen.providers.pep621_provider import Pep621Provider
 from commitizen.providers.poetry_provider import PoetryProvider
@@ -24,6 +25,7 @@
     "CargoProvider",
     "CommitizenProvider",
     "ComposerProvider",
+    "DartProvider",
     "NpmProvider",
     "Pep621Provider",
     "PoetryProvider",

commitizen/providers/dart_provider.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from pathlib import Path
+from typing import Any
+
+from ruamel.yaml import YAML
+
+from commitizen.providers.base_provider import VersionProvider
+
+
+class DartProvider(VersionProvider):
+    """
+    dart pubspec.yaml version management
+    """
+
+    package_filename = "pubspec.yaml"
+
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self._yaml = YAML()
+        self._yaml.preserve_quotes = True
+        self._yaml.indent(mapping=2, sequence=4, offset=2)
+
+    @property
+    def package_file(self) -> Path:
+        return Path() / self.package_filename
+
+    def get_version(self) -> str:
+        print(self.package_file.read_text())
+        document = self._yaml.load(self.package_file.read_text())
+        return self.get(document)
+
+    def set_version(self, version: str) -> None:
+        document = self._yaml.load(self.package_file.read_text())
+        self.set(document, version)
+        self._yaml.dump(document, self.package_file)
+
+    def get(self, document: Mapping[str, str]) -> str:
+        # Extract the version without the build number
+        version = document["version"]
+        return version.split("+")[0] if "+" in version else version
+
+    def set(self, document: dict[str, Any], version: str) -> None:
+        # To enforce to save the version in pubspec without quotes
+        # even if the version could be interpreted as float by yaml
+        # dump
+        version_value: Any
+        try:
+            version_value = float(version)
+        except ValueError:
+            version_value = version
+        document["version"] = version_value

docs/commands/init.md

@@ -33,6 +33,7 @@ During the initialization process, you'll be prompted to configure the following
 2. **Version Provider**: Choose how to manage versioning in your project. Commitizen supports multiple version management systems:
     - `commitizen`: Uses Commitizen's built-in version management system
     - `npm`: Manages version in `package.json` for Node.js projects
+    - `dart`: Manages version in `pubspec.yaml` for Dart projects
     - `cargo`: Manages version in `Cargo.toml` for Rust projects
     - `composer`: Manages version in `composer.json` for PHP projects
     - `pep621`: Uses `pyproject.toml` with PEP 621 standard

docs/config.md

@@ -355,6 +355,7 @@ Commitizen provides some version providers for some well known formats:
 | `uv`         | Get and set version from `pyproject.toml` `project.version` field and `uv.lock` `package.version` field whose `package.name` field is the same as `pyproject.toml` `project.name` field                                 |
 | `cargo`      | Get and set version from `Cargo.toml` `package.version` field and `Cargo.lock` `package.version` field whose `package.name` field is the same as `Cargo.toml` `package.name` 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 |
+| `dart`       | Get and set version from `pubspec.yaml` `version` field |
 | `composer`   | Get and set version from `composer.json` `project.version` field                                                                                                                                                        |
 
 !!! note

poetry.lock

@@ -24,6 +24,7 @@ dependencies = [
     "charset-normalizer (>=2.1.0,<4)",
     # Use the Python 3.11 and 3.12 compatible API: https://github.com/python/importlib_metadata#compatibility
     "importlib-metadata >=8.0.0,<8.7.0 ; python_version < '3.10'",
+    "ruamel-yaml (>=0.18.14,<0.19.0)",
 ]
 keywords = ["commitizen", "conventional", "commits", "git"]
 # See also: https://pypi.org/classifiers/
@@ -71,6 +72,7 @@ cargo = "commitizen.providers:CargoProvider"
 commitizen = "commitizen.providers:CommitizenProvider"
 composer = "commitizen.providers:ComposerProvider"
 npm = "commitizen.providers:NpmProvider"
+dart = "commitizen.providers:DartProvider"
 pep621 = "commitizen.providers:Pep621Provider"
 poetry = "commitizen.providers:PoetryProvider"
 scm = "commitizen.providers:ScmProvider"

pyproject.toml

@@ -0,0 +1,164 @@
+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.dart_provider import DartProvider
+
+DART_YAML = """\
+name: my_super_package
+description: A new Flutter project.
+
+# Bla, bla, bla
+publish_to: "none" # Remove this line if you wish to publish to pub.dev
+
+version: 0.1.0+1
+
+environment:
+  sdk: ^3.7.2
+  # note that this only enforces that the Flutter version is at least the value specified. It does not
+  # force it to this specific version
+  flutter: 3.29.2
+
+# Bla, bla, bla
+dependencies:
+  flutter:
+    sdk: flutter
+
+  # Some package dependencies
+  # network
+  dio: ^5.8.0+1
+
+# The following section is specific to Flutter packages.
+flutter:
+  # The following line ensures that the Material Icons font is
+  # included with your application, so that you can use the icons in
+  # the material Icons class.
+  uses-material-design: true
+
+  # To add assets to your application, add an assets section, like this:
+  assets:
+    - assets/images/
+"""
+
+DART_YAML_FLOAT_PARSEABLE_EXPECTED = """\
+name: my_super_package
+description: A new Flutter project.
+
+# Bla, bla, bla
+publish_to: "none" # Remove this line if you wish to publish to pub.dev
+
+version: 42.1
+
+environment:
+  sdk: ^3.7.2
+  # note that this only enforces that the Flutter version is at least the value specified. It does not
+  # force it to this specific version
+  flutter: 3.29.2
+
+# Bla, bla, bla
+dependencies:
+  flutter:
+    sdk: flutter
+
+  # Some package dependencies
+  # network
+  dio: ^5.8.0+1
+
+# The following section is specific to Flutter packages.
+flutter:
+  # The following line ensures that the Material Icons font is
+  # included with your application, so that you can use the icons in
+  # the material Icons class.
+  uses-material-design: true
+
+  # To add assets to your application, add an assets section, like this:
+  assets:
+    - assets/images/
+"""
+
+DART_YAML_SEMVER_EXPECTED = """\
+name: my_super_package
+description: A new Flutter project.
+
+# Bla, bla, bla
+publish_to: "none" # Remove this line if you wish to publish to pub.dev
+
+version: 2.3.4
+
+environment:
+  sdk: ^3.7.2
+  # note that this only enforces that the Flutter version is at least the value specified. It does not
+  # force it to this specific version
+  flutter: 3.29.2
+
+# Bla, bla, bla
+dependencies:
+  flutter:
+    sdk: flutter
+
+  # Some package dependencies
+  # network
+  dio: ^5.8.0+1
+
+# The following section is specific to Flutter packages.
+flutter:
+  # The following line ensures that the Material Icons font is
+  # included with your application, so that you can use the icons in
+  # the material Icons class.
+  uses-material-design: true
+
+  # To add assets to your application, add an assets section, like this:
+  assets:
+    - assets/images/
+"""
+
+
+@pytest.mark.parametrize(
+    "content, expected",
+    ((DART_YAML, DART_YAML_FLOAT_PARSEABLE_EXPECTED),),
+)
+def test_dart_provider_with_float_parseable_new_version(
+    config: BaseConfig,
+    chdir: Path,
+    content: str,
+    expected: str,
+):
+    filename = DartProvider.package_filename
+    file = chdir / filename
+    file.write_text(dedent(content))
+    config.settings["version_provider"] = "dart"
+
+    provider = get_provider(config)
+    assert isinstance(provider, DartProvider)
+    assert provider.get_version() == "0.1.0"
+
+    provider.set_version("42.1")
+    assert file.read_text() == dedent(expected)
+
+
+@pytest.mark.parametrize(
+    "content, expected",
+    ((DART_YAML, DART_YAML_SEMVER_EXPECTED),),
+)
+def test_dart_provider_with_semver_new_version(
+    config: BaseConfig,
+    chdir: Path,
+    content: str,
+    expected: str,
+):
+    filename = DartProvider.package_filename
+    file = chdir / filename
+    file.write_text(dedent(content))
+    config.settings["version_provider"] = "dart"
+
+    provider = get_provider(config)
+    assert isinstance(provider, DartProvider)
+    assert provider.get_version() == "0.1.0"
+
+    provider.set_version("2.3.4")
+    assert file.read_text() == dedent(expected)