badgerp_get_crates_version 0.1.0__tar.gz

badgerp_get_crates_version-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+/target
+/dist
+/.venv
+__pycache__/
+*.pyc
+plugins/**/.packages/
+test.svg
+badges/
+/plugins/repology-badge/.site-packages
+plugins/**/dist/
+plugins/**/*.egg-info/
+.pytest_cache/
+mutants.out*
+/mutants.out*
+/xz2-0.1.7

badgerp_get_crates_version-0.1.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.5
+Name: badgerp_get_crates_version
+Version: 0.1.0
+Summary: Show the latest published version of a crate from crates.io
+Author-email: 𝑷𝒉𝒊𝒍𝒐𝒄𝒂𝒍𝒚𝒔𝒕 <regime_skylark.0y@icloud.com>
+License-Expression: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# get-crates-version
+
+A [badger](https://github.com/) plugin that looks up the latest published
+version of a crate from crates.io.
+
+By default it resolves the crate name from a `Cargo.toml` in the current
+directory (with basic support for workspaces), then queries the crates.io
+API and returns a `crates.io: <version>` badge entry. You can also pass an
+explicit `crate` name to skip the `Cargo.toml` lookup.
+
+This package is not meant to be used as a standalone library — badger loads
+`plugin.py`'s `run()` function directly as its entrypoint.

badgerp_get_crates_version-0.1.0/README.md

@@ -0,0 +1,12 @@
+# get-crates-version
+
+A [badger](https://github.com/) plugin that looks up the latest published
+version of a crate from crates.io.
+
+By default it resolves the crate name from a `Cargo.toml` in the current
+directory (with basic support for workspaces), then queries the crates.io
+API and returns a `crates.io: <version>` badge entry. You can also pass an
+explicit `crate` name to skip the `Cargo.toml` lookup.
+
+This package is not meant to be used as a standalone library — badger loads
+`plugin.py`'s `run()` function directly as its entrypoint.

badgerp_get_crates_version-0.1.0/plugin.py

@@ -0,0 +1,62 @@
+# This badge does the really simple thing of getting the CURRENTLY PUBLISHED crates version
+# This is subtly different from the version of the crate in question in your repo because it's not FOR SURE
+# on crates.io yet (just is the expectation).
+
+import json
+import tomllib
+import urllib.request
+from badger import entry
+
+
+def _crate_name_from_toml(cargo_toml: str) -> str:
+    """Resolve the crate name from a Cargo.toml, with workspace support.
+
+    Handles three shapes:
+    - ``[package]`` only — a normal single-crate project.
+    - ``[package]`` + ``[workspace]`` — a workspace root that is also a
+      publishable crate (e.g. ``badger`` itself).
+    - ``[workspace]`` only (virtual workspace) — no ``[package]`` at the root.
+      Falls back to ``workspace.package.name`` if the workspace defines
+      inherited package metadata; otherwise raises with a helpful message.
+    """
+    with open(cargo_toml, "rb") as f:
+        data = tomllib.load(f)
+
+    if "package" in data:
+        return data["package"]["name"]
+
+    # Virtual workspace: try workspace-level inherited package metadata.
+    workspace = data.get("workspace", {})
+    workspace_pkg_name = workspace.get("package", {}).get("name")
+    if workspace_pkg_name:
+        return workspace_pkg_name
+
+    members = workspace.get("members", [])
+    raise ValueError(
+        f"{cargo_toml!r} is a virtual workspace root (no [package] section). "
+        f"Workspace members: {members}. "
+        "Pass crate='<name>' explicitly to get-crates-version, or point "
+        "cargo_toml at a specific member's Cargo.toml."
+    )
+
+
+def run(crate: str = "", cargo_toml: str = "Cargo.toml") -> entry:
+    """Fetch the newest crates.io release for a crate.
+
+    When no crate name is supplied, the package name is resolved from the
+    given Cargo manifest, including workspace metadata where available.
+
+    Args:
+        crate: crates.io package name; empty uses the manifest's package name.
+        cargo_toml: manifest used when `crate` is empty.
+    """
+    if not crate:
+        crate = _crate_name_from_toml(cargo_toml)
+
+    req = urllib.request.Request(
+        f"https://crates.io/api/v1/crates/{crate}",
+        headers={"User-Agent": "badger-badge-generator/0.1"},
+    )
+    with urllib.request.urlopen(req, timeout=10) as resp:
+        version = json.loads(resp.read().decode())["crate"]["newest_version"]
+    return entry(label="crates.io", status=version)

badgerp_get_crates_version-0.1.0/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "badgerp_get_crates_version"
+version = "0.1.0"
+description = "Show the latest published version of a crate from crates.io"
+readme = "README.md"
+license = "MIT"
+authors = [{ name = "𝑷𝒉𝒊𝒍𝒐𝒄𝒂𝒍𝒚𝒔𝒕", email = "regime_skylark.0y@icloud.com" }]
+dependencies = []
+requires-python = ">=3.11"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+include = ["plugin.py"]

badgerp_get_crates_version-0.1.0/tests/test_plugin.py

@@ -0,0 +1,117 @@
+import textwrap
+
+import pytest
+
+
+@pytest.mark.network
+def test_label(plugin):
+    assert plugin.run(crate="serde").label == "crates.io"
+
+
+@pytest.mark.network
+def test_version_is_semver(plugin):
+    parts = plugin.run(crate="serde").status.split(".")
+    assert len(parts) >= 2
+    assert parts[0].isdigit()
+
+
+@pytest.mark.network
+def test_unknown_crate_raises(plugin):
+    with pytest.raises(Exception):
+        plugin.run(crate="this-crate-does-not-exist-xyzzy-99999")
+
+
+@pytest.mark.network
+def test_infers_crate_from_cargo_toml(plugin, monkeypatch, project_root):
+    monkeypatch.chdir(project_root)
+    result = plugin.run()
+    assert result.label == "crates.io"
+    assert result.status
+
+
+@pytest.fixture
+def tmp_toml(tmp_path):
+    """Write a Cargo.toml in a temp dir and return its absolute path."""
+    def _write(content: str) -> str:
+        path = tmp_path / "Cargo.toml"
+        path.write_text(textwrap.dedent(content))
+        return str(path)
+    return _write
+
+
+def test_crate_name_from_package_only_toml(plugin, tmp_toml):
+    path = tmp_toml("""\
+        [package]
+        name = "my-crate"
+        version = "0.1.0"
+        edition = "2021"
+    """)
+    assert plugin._crate_name_from_toml(path) == "my-crate"
+
+
+def test_crate_name_from_package_plus_workspace_toml(plugin, tmp_toml):
+    """A crate that is also the workspace root (e.g. badger itself)."""
+    path = tmp_toml("""\
+        [package]
+        name = "root-crate"
+        version = "0.1.0"
+        edition = "2021"
+
+        [workspace]
+        members = ["sub-a", "sub-b"]
+    """)
+    assert plugin._crate_name_from_toml(path) == "root-crate"
+
+
+def test_crate_name_from_virtual_workspace_with_inherited_package(plugin, tmp_toml):
+    """Virtual workspace that declares workspace.package.name."""
+    path = tmp_toml("""\
+        [workspace]
+        members = ["crate-a", "crate-b"]
+
+        [workspace.package]
+        name = "my-workspace"
+        version = "1.0.0"
+        edition = "2021"
+    """)
+    assert plugin._crate_name_from_toml(path) == "my-workspace"
+
+
+def test_crate_name_from_virtual_workspace_without_package_raises(plugin, tmp_toml):
+    path = tmp_toml("""\
+        [workspace]
+        members = ["crate-a", "crate-b"]
+    """)
+    with pytest.raises(ValueError, match="virtual workspace root"):
+        plugin._crate_name_from_toml(path)
+
+
+def test_virtual_workspace_error_mentions_members(plugin, tmp_toml):
+    path = tmp_toml("""\
+        [workspace]
+        members = ["alpha", "beta"]
+    """)
+    with pytest.raises(ValueError, match="alpha"):
+        plugin._crate_name_from_toml(path)
+
+
+def test_explicit_crate_kwarg_skips_toml_read(plugin, tmp_toml, monkeypatch):
+    """When crate= is provided the Cargo.toml is never opened."""
+    path = tmp_toml("""\
+        [workspace]
+        members = ["a"]
+    """)
+
+    original_open = open
+
+    def _guarded(name, *args, **kwargs):
+        if str(name) == path:
+            raise AssertionError(f"Cargo.toml should not be read when crate= is explicit: {name}")
+        return original_open(name, *args, **kwargs)
+
+    monkeypatch.setattr("builtins.open", _guarded)
+
+    # We expect a network/URL error, NOT a ValueError about virtual workspaces.
+    with pytest.raises(Exception) as exc_info:
+        plugin.run(crate="some-crate-name", cargo_toml=path)
+    assert "virtual workspace root" not in str(exc_info.value)

badgerp_get_crates_version-0.1.0/uv.lock

@@ -0,0 +1,8 @@
+version = 1
+revision = 3
+requires-python = ">=3.11"
+
+[[package]]
+name = "badgerp-get-crates-version"
+version = "0.1.0"
+source = { editable = "." }