Map name (issue) bt->gh (#116)

* feat: let policy take optional equality fn param

* feat: implement name map

* feat: wire name map

* fix: pass correct arguments in wire

* doc: add placeholder for diagram

Author: thatmariia

docs/source/api_reference/diagrams.rst

@@ -133,6 +133,11 @@ bio.tools → GitHub mapping for pull requests
 The flowcharts below detail the mapping of specific fields from bio.tools to GitHub
 in the form of pull requests.
 
+Map name
+~~~~~~~~~~
+
+TODO: add diagram here.
+
 Map license
 ~~~~~~~~~~~~~~~~
 

src/bridge/pipelines/bt2gh_for_pr/map.py

@@ -9,7 +9,16 @@
 from bridge.pipelines.protocols import MapItem, Method, ModelsMap
 from bridge.pipelines.utils import load_dict_from_yaml_file
 
-from .map_funcs import map_citation, map_description, map_homepage, map_license, map_readme, map_topics, map_version
+from .map_funcs import (
+    map_citation,
+    map_description,
+    map_homepage,
+    map_license,
+    map_name,
+    map_readme,
+    map_topics,
+    map_version,
+)
 
 
 class MapDestination(BaseModel):
@@ -24,7 +33,7 @@ class MapDestination(BaseModel):
         List of properties to be mapped to pull requests.
     """
 
-    issue: list[str] = ["description", "homepage", "topics", "version"]
+    issue: list[str] = ["name", "description", "homepage", "topics", "version"]
     pr: list[str] = ["citation", "readme", "license"]
 
 
@@ -43,7 +52,15 @@ def map(self) -> dict[str, MapItem]:
         Map bio.tools metadata property to corresponding GitHub property.
         """
         return {
-            "name": MapItem(schema_entry=self.metadata.name, repo_entry=self.repo.repo.name, method=Method.EXACT),
+            "name": MapItem(
+                schema_entry={
+                    "name": self.metadata.name,
+                    "biotoolsID": self.metadata.biotoolsID.root,
+                },
+                repo_entry=self.repo.repo.name,
+                method=Method.EXACT,
+                fn=map_name,
+            ),
             "version": MapItem(
                 schema_entry=self.metadata.version,
                 repo_entry=self.repo.latest_release.tag_name,

src/bridge/pipelines/bt2gh_for_pr/map_funcs/__init__.py

@@ -6,6 +6,7 @@
 from .description import map_description
 from .homepage import map_homepage
 from .license import map_license
+from .name import map_name
 from .readme import map_readme
 from .topics import map_topics
 from .version import map_version
@@ -18,4 +19,5 @@
     "map_readme",
     "map_license",
     "map_version",
+    "map_name",
 ]

src/bridge/pipelines/bt2gh_for_pr/map_funcs/name.py

@@ -0,0 +1,65 @@
+"""
+Map repository name from bio.tools to GitHub.
+
+This module compares the bio.tools name and ID with the GitHub repository name.
+If the GitHub name does not match either, it proposes an issue suggesting
+to update the repository name to the bio.tools ID.
+It applies a bio.tools-over-GitHub issue policy.
+"""
+
+from bridge.logging import get_user_logger
+from bridge.pipelines.policies.bt2gh import reconcile_bt_over_gh
+from bridge.pipelines.utils import normalize_text, str_contain_each_other
+
+logger = get_user_logger()
+
+
+def map_name(gh_name: str | None, bt_params: dict[str, str | None] | None) -> dict[str, str] | None:
+    """
+    Propose a GitHub issue to update the GitHub repository name based on bio.tools name and ID metadata,
+    using the generic bio.tools-over-GitHub issue policy.
+
+    Parameters
+    ----------
+    gh_name : str | None
+        GitHub repository name.
+    bt_params : dict[str, str | None] | None
+        A dictionary containing existing bio.tools metadata parameters.
+        Expected keys:
+        - ``"name"``       : bio.tools name
+        - ``"biotoolsID"`` : bio.tools ID
+
+    Returns
+    -------
+    dict[str, str] | None
+        A mapping with the issue title as key and the issue body as value,
+        or ``None`` if no issue is to be created.
+    """
+    if bt_params is None:
+        logger.unchanged("No bio.tools params found, nothing to map.")
+        return None
+
+    bt_name = bt_params.get("name")
+    bt_id = bt_params.get("biotoolsID")
+
+    gh_norm = normalize_text(gh_name)
+    bt_name_norm = normalize_text(bt_name)
+    bt_id_norm = normalize_text(bt_id)
+
+    def make_issue(name: str) -> dict[str, str]:
+        return {
+            "Update repository name from bio.tools metadata": (
+                f"The GitHub repository name '{gh_name}' does not match the bio.tools "
+                f"name '{bt_name}' or ID '{bt_id}'.\n\n"
+                f"Proposed new name: '{bt_id}'.\n\n"
+                "Please consider updating the repository name."
+            ),
+        }
+
+    return reconcile_bt_over_gh(
+        bt_norm=bt_id_norm,
+        gh_norm=gh_norm,
+        make_output=make_issue,
+        log_label="name/id",
+        equality_fn=lambda gh, bt: str_contain_each_other(gh, bt) or str_contain_each_other(gh, bt_name_norm),
+    )

src/bridge/pipelines/policies/bt2gh/reconcile_bt_over_gh.py

@@ -26,6 +26,7 @@ async def reconcile_bt_over_gh(
     bt_norm: BTN | None,
     make_output: Callable[[BTN], Awaitable[OUTPUT] | OUTPUT],
     log_label: str,
+    equality_fn: Callable[[GHN, BTN], bool] | None = None,
 ) -> OUTPUT | None:
     """
     Apply a generic bio.tools-over-GitHub policy to decide whether to
@@ -63,6 +64,10 @@ async def reconcile_bt_over_gh(
     log_label : str
         Short label used in log messages to identify the metadata field
         (e.g., ``"description"``, ``"homepage"``, ``"license"``).
+    equality_fn : Callable[[GHN, BTN], bool] | None, optional
+        Optional equality function to compare normalized GitHub and
+        bio.tools values. If ``None``, the default equality operator
+        (``==``) is used.
 
     Returns
     -------
@@ -75,7 +80,12 @@ async def reconcile_bt_over_gh(
         return None
 
     if gh_norm is not None:
-        if gh_norm == bt_norm:
+        if equality_fn is not None:
+            equal = equality_fn(gh_norm, bt_norm)
+        else:
+            equal = gh_norm == bt_norm
+
+        if equal:
             logger.exact(f"bio.tools {log_label} matches GitHub {log_label}, no need to map.")
             return None