Merge branch 'object-Object:main' into embed-colours

Author: mercurialworld

CHANGELOG.md

@@ -4,7 +4,19 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and [Pydantic's HISTORY.md](https://github.com/pydantic/pydantic/blob/main/HISTORY.md), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## `0.1.1`
+## [UNRELEASED]
+
+### Added
+
+* GitHub Utils now uses [Fluent](https://projectfluent.org/) to localize command/parameter descriptions.
+* Added `/gh user`, by [mercurialworld](https://github.com/mercurialworld) in [#2](https://github.com/object-Object/discord-github-utils/pull/2).
+
+### Changed
+
+* Changed the repository search algorithm to allow fuzzy owner searches (eg. `object/discord` will now suggest `object-Object/discord-github-utils`).
+* `/gh_config[_admin] set default_repo` will now return an error if the repository does not exist.
+
+## `0.1.1` - 2024-11-09
 
 ### Changed
 
@@ -14,6 +26,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 * Added a workaround for the delete button not working in servers or DMs where the bot is not present (ie. user installs).
 
-## `0.1.0`
+## `0.1.0` - 2024-11-05
 
 Initial release.

bot/src/ghutils/cogs/app_commands/config/admin.py

@@ -7,7 +7,8 @@
 
 from ghutils.core.cog import GHUtilsCog, SubGroup
 from ghutils.db.config import get_guild_config
-from ghutils.utils.discord.transformers import RepositoryNameOption
+from ghutils.utils.discord.transformers import RepositoryOption
+from ghutils.utils.github import RepositoryName
 
 type ServerConfigOption = Literal[
     "default_repo",
@@ -77,12 +78,13 @@ class Set(SubGroup):
         async def default_repo(
             self,
             interaction: Interaction,
-            value: RepositoryNameOption,
+            value: RepositoryOption,
         ):
+            new_value = RepositoryName.parse(value.full_name)
             with self._update_config(interaction) as config:
                 old_value = config.default_repo
-                config.default_repo = value
-            await _send_updated(interaction, "default_repo", old_value, value)
+                config.default_repo = new_value
+            await _send_updated(interaction, "default_repo", old_value, new_value)
 
         @contextmanager
         def _update_config(self, interaction: Interaction):

bot/src/ghutils/cogs/app_commands/config/user.py

@@ -8,7 +8,8 @@
 
 from ghutils.core.cog import GHUtilsCog, SubGroup
 from ghutils.db.config import get_user_config, get_user_guild_config
-from ghutils.utils.discord.transformers import RepositoryNameOption
+from ghutils.utils.discord.transformers import RepositoryOption
+from ghutils.utils.github import RepositoryName
 
 type UserConfigOption = Literal[
     "default_repo",
@@ -90,12 +91,13 @@ class Set(SubGroup):
         async def default_repo(
             self,
             interaction: Interaction,
-            value: RepositoryNameOption,
+            value: RepositoryOption,
         ):
+            new_value = RepositoryName.parse(value.full_name)
             with self._update_config(interaction) as config:
                 old_value = config.default_repo
-                config.default_repo = value
-            await _send_updated(interaction, "default_repo", old_value, value)
+                config.default_repo = new_value
+            await _send_updated(interaction, "default_repo", old_value, new_value)
 
         @contextmanager
         def _update_config(self, interaction: Interaction):

bot/src/ghutils/cogs/app_commands/github.py

@@ -27,14 +27,13 @@
     UserGitHubTokens,
     UserLogin,
 )
-from ghutils.utils import l10n
 from ghutils.utils.discord.embeds import set_embed_author
 from ghutils.utils.discord.references import (
     CommitReference,
     IssueReference,
     PRReference,
 )
-from ghutils.utils.discord.transformers import FullRepositoryOption, UserOption
+from ghutils.utils.discord.transformers import RepositoryOption, UserOption
 from ghutils.utils.discord.visibility import MessageVisibility, respond_with_visibility
 from ghutils.utils.github import (
     CommitCheckState,
@@ -57,7 +56,6 @@ class GitHubCog(GHUtilsCog, GroupCog, group_name="gh"):
 
     @app_commands.command()
     @app_commands.rename(reference="issue")
-    @l10n.describe_common("visibility")
     async def issue(
         self,
         interaction: Interaction,
@@ -72,7 +70,6 @@ async def issue(
 
     @app_commands.command()
     @app_commands.rename(reference="pr")
-    @l10n.describe_common("visibility")
     async def pr(
         self,
         interaction: Interaction,
@@ -87,7 +84,6 @@ async def pr(
 
     @app_commands.command()
     @app_commands.rename(reference="commit")
-    @l10n.describe_common("visibility")
     async def commit(
         self,
         interaction: Interaction,
@@ -128,11 +124,10 @@ async def commit(
         await respond_with_visibility(interaction, visibility, embed=embed)
 
     @app_commands.command()
-    @l10n.describe_common("visibility")
     async def repo(
         self,
         interaction: Interaction,
-        repo: FullRepositoryOption,
+        repo: RepositoryOption,
         visibility: MessageVisibility = "private",
     ):
         async with self.bot.github_app(interaction) as (github, _):
@@ -164,7 +159,6 @@ async def repo(
         await respond_with_visibility(interaction, visibility, embed=embed)
 
     @app_commands.command()
-    @l10n.describe_common("visibility")
     async def user(
         self,
         interaction: Interaction,
@@ -265,7 +259,6 @@ async def logout(self, interaction: Interaction):
                 )
 
     @app_commands.command()
-    @l10n.describe_common("visibility")
     async def status(
         self,
         interaction: Interaction,
@@ -324,11 +317,10 @@ async def status(
 
     class Search(SubGroup):
         @app_commands.command()
-        @l10n.describe_common("visibility")
         async def files(
             self,
             interaction: Interaction,
-            repo: FullRepositoryOption,
+            repo: RepositoryOption,
             query: Range[str, 1, 128],
             ref: Range[str, 1, 255] | None = None,
             exact: bool = False,

bot/src/ghutils/resources/l10n/en-US/main.ftl

@@ -6,7 +6,7 @@
 
 # common parameters
 
-parameter-description_common_visibility =
+-parameter-description_visibility =
     Whether the message should be visible to everyone, or just you.
 
 # /gh issue
@@ -17,6 +17,9 @@ command-description_gh-issue =
 parameter-description_gh-issue_reference =
     Issue to look up (`owner/repo#123` or `#123`). Use `/gh login` to get autocomplete.
 
+parameter-description_gh-issue_visibility =
+    {-parameter-description_visibility}
+
 # /gh pr
 
 command-description_gh-pr =
@@ -25,6 +28,9 @@ command-description_gh-pr =
 parameter-description_gh-pr_reference =
     Pull request to look up (`owner/repo#123` or `#123`). Use `/gh login` to get autocomplete.
 
+parameter-description_gh-pr_visibility =
+    {-parameter-description_visibility}
+
 # /gh commit
 
 command-description_gh-commit =
@@ -33,16 +39,31 @@ command-description_gh-commit =
 parameter-description_gh-commit_reference =
     Commit SHA to look up (`owner/repo@sha` or `@sha`). Use `/gh login` to get autocomplete.
 
+parameter-description_gh-commit_visibility =
+    {-parameter-description_visibility}
+
 # /gh repo
 
 command-description_gh-repo =
     Get a link to a GitHub repository.
 
+parameter-description_gh-repo_repo =
+    Repository to look up (`owner/repo`). Use `/gh login` to get autocomplete.
+
+parameter-description_gh-repo_visibility =
+    {-parameter-description_visibility}
+
 # /gh user
 
 command-description_gh-user =
     Get a link to a GitHub user.
 
+parameter-description_gh-repo_user =
+    Username to look up. Use `/gh login` to get autocomplete.
+
+parameter-description_gh-user_visibility =
+    {-parameter-description_visibility}
+
 # /gh login
 
 command-description_gh-login =
@@ -58,6 +79,9 @@ command-description_gh-logout =
 command-description_gh-status =
     Show information about GitHub Utils.
 
+parameter-description_gh-status_visibility =
+    {-parameter-description_visibility}
+
 # /gh search
 
 command-description_gh-search =
@@ -82,3 +106,6 @@ parameter-description_gh-search-files_exact =
 
 parameter-description_gh-search-files_limit =
     Maximum number of results to show.
+
+parameter-description_gh-search-files_visibility =
+    {-parameter-description_visibility}

bot/src/ghutils/utils/discord/transformers.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import logging
-from typing import Any
 
 from discord import Interaction
 from discord.app_commands import Transform, Transformer
@@ -19,20 +18,29 @@
 logger = logging.getLogger(__name__)
 
 
-class RepositoryNameTransformer(Transformer):
-    async def transform(self, interaction: Interaction, value: str) -> Any:
-        return RepositoryName.parse(value)
+class RepositoryTransformer(Transformer):
+    async def transform(self, interaction: Interaction, value: str) -> FullRepository:
+        repo = RepositoryName.parse(value)
+        async with GHUtilsBot.github_app_of(interaction) as (github, _):
+            try:
+                return await gh_request(
+                    github.rest.repos.async_get(repo.owner, repo.repo)
+                )
+            except GitHubException as e:
+                match e:
+                    case RequestFailed(response=Response(status_code=404)):
+                        raise ValueError("Repository not found")
+                    case _:
+                        logger.warning(e)
+                        raise ValueError(f"Failed to get repository: {e}")
 
     async def autocomplete(  # pyright: ignore[reportIncompatibleMethodOverride]
         self,
         interaction: Interaction,
         value: str,
     ) -> list[Choice[str]]:
         value = value.strip()
-        if "/" in value:
-            owner, rest = value.split("/", maxsplit=1)
-            query = f"{rest} user:{owner} in:name fork:true"
-        elif value:
+        if value:
             query = f"{value} in:name fork:true"
         else:
             with GHUtilsBot.db_session_of(interaction) as session:
@@ -64,25 +72,12 @@ async def autocomplete(  # pyright: ignore[reportIncompatibleMethodOverride]
             ]
 
 
-class FullRepositoryTransformer(RepositoryNameTransformer):
-    async def transform(self, interaction: Interaction, value: str):
-        repo = RepositoryName.parse(value)
-        async with GHUtilsBot.github_app_of(interaction) as (github, _):
-            try:
-                return await gh_request(
-                    github.rest.repos.async_get(repo.owner, repo.repo)
-                )
-            except GitHubException as e:
-                match e:
-                    case RequestFailed(response=Response(status_code=404)):
-                        raise ValueError("Repository not found")
-                    case _:
-                        logger.warning(e)
-                        raise ValueError(f"Failed to get repository: {e}")
-
-
 class UserTransformer(Transformer):
-    async def transform(self, interaction: Interaction, value: str):
+    async def transform(
+        self,
+        interaction: Interaction,
+        value: str,
+    ) -> PrivateUser | PublicUser:
         async with GHUtilsBot.github_app_of(interaction) as (github, _):
             try:
                 return await gh_request(github.rest.users.async_get_by_username(value))
@@ -95,7 +90,9 @@ async def transform(self, interaction: Interaction, value: str):
                         raise ValueError(f"Failed to get user: {e}")
 
     async def autocomplete(  # pyright: ignore[reportIncompatibleMethodOverride]
-        self, interaction: Interaction, value: str
+        self,
+        interaction: Interaction,
+        value: str,
     ) -> list[Choice[str]]:
         async with GHUtilsBot.github_app_of(interaction) as (github, state):
             if state != LoginState.LOGGED_IN:
@@ -122,8 +119,6 @@ async def autocomplete(  # pyright: ignore[reportIncompatibleMethodOverride]
             return [Choice(name=user.login, value=user.login) for user in result.items]
 
 
-UserOption = Transform[PrivateUser | PublicUser, UserTransformer]
-
-RepositoryNameOption = Transform[RepositoryName, RepositoryNameTransformer]
+RepositoryOption = Transform[FullRepository, RepositoryTransformer]
 
-FullRepositoryOption = Transform[FullRepository, FullRepositoryTransformer]
+UserOption = Transform[PrivateUser | PublicUser, UserTransformer]

bot/src/ghutils/utils/l10n.py

@@ -1,9 +1,7 @@
 """Localization helpers."""
 
 import re
-from typing import Mapping
 
-from discord import app_commands
 from discord.app_commands import locale_str
 
 type StrIterable = list[str] | tuple[str, ...]
@@ -30,28 +28,5 @@ def parameter_description(command: str | None, parameter: str):
     return locale_str("...", id=parameter_description_id(command, parameter))
 
 
-def describe_common(*parameters: str):
-    return describe(common=parameters)
-
-
-def describe(
-    dict_args: Mapping[str, StrIterable] | None = None,
-    **kwargs: StrIterable,
-):
-    """Localize app command parameters.
-
-    Key: command to localize parameters for.
-
-    Value: parameter names.
-    """
-    if dict_args:
-        kwargs |= dict_args
-    return app_commands.describe(**{
-        parameter: parameter_description(command, parameter)
-        for command, parameters in kwargs.items()
-        for parameter in parameters
-    })
-
-
 def _format_identifier(command: str):
     return _SEPARATOR_PATTERN.sub("-", command).replace("/", "")