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

Add a few cases commands to fun.py to output a string in a specific case. #1455

Closed
wants to merge 11 commits into from
76 changes: 65 additions & 11 deletions bot/exts/fun/fun.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import json
import random
from collections.abc import Iterable
from collections.abc import Callable, Iterable
from pathlib import Path
from typing import Literal

Expand Down Expand Up @@ -51,6 +51,21 @@ def _get_random_die() -> str:
die_name = f"dice_{random.randint(1, 6)}"
return getattr(Emojis, die_name)

@staticmethod
async def _clean_text(ctx: Context, text: str, conversion_func: Callable[[str], str]) -> tuple[str, Embed]:
"""This groups the clean and convert functions into one so we can reuse this without duplicated code."""
text = await clean_text_or_reply(ctx, text)
text, embed = await messages.get_text_and_embed(ctx, text)
# Convert embed if it exists
if embed is not None:
embed = messages.convert_embed(conversion_func, embed)
converted_text = conversion_func(text)
converted_text = helpers.suppress_links(converted_text)
# Don't put >>> if only embed present
if converted_text:
converted_text = f">>> {converted_text.lstrip('> ')}"
return converted_text, embed

@commands.command()
async def roll(self, ctx: Context, num_rolls: int = 1) -> None:
"""Outputs a number of random dice emotes (up to 6)."""
Expand All @@ -68,16 +83,55 @@ def conversion_func(text: str) -> str:
return "".join(
char.upper() if round(random.random()) else char.lower() for char in text
)
text = await clean_text_or_reply(ctx, text)
text, embed = await messages.get_text_and_embed(ctx, text)
# Convert embed if it exists
if embed is not None:
embed = messages.convert_embed(conversion_func, embed)
converted_text = conversion_func(text)
converted_text = helpers.suppress_links(converted_text)
# Don't put >>> if only embed present
if converted_text:
converted_text = f">>> {converted_text.lstrip('> ')}"
converted_text, embed = await self._clean_text(ctx, text, conversion_func)
await ctx.send(content=converted_text, embed=embed)

@commands.command(name="snakecase", aliases=("scase",))
async def snakecase_command(self, ctx: Context, *, text: str | None) -> None:
"""Attempts to convert the provided string to snake_case."""
text = helpers.neutralise_string(text)
def conversion_func(text: str) -> str:
"""Converts the provided string to snake_case."""
return "_".join(
text.split()
)
converted_text, embed = await self._clean_text(ctx, text, conversion_func)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a nit

Suggested change
converted_text, embed = await self._clean_text(ctx, text, conversion_func)
cleaned_text, embed = await self._clean_text(ctx, text, conversion_func)

Since the function's name indicates "cleaning" rather than "converting"

await ctx.send(content=converted_text, embed=embed)

@commands.command(name="pascalcase", aliases=("pcase", "pascal",))
async def pascalcase_command(self, ctx: Context, *, text: str | None) -> None:
"""Attempts to convert the provided string to pascalCase."""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If i'm not mistaken, it's the other way around where PascalCase should be pascalCase and CamelCase should be camelCase

So both docstrings & conversion functions need to be switched

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cant believe I had them the wrong way around hey. Fixed in both files now xD

text = helpers.neutralise_string(text)
def conversion_func(text: str) -> str:
"""Converts the provided string to pascalCase."""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same note here for the docstring about the pascal & camel case notation

return "".join(
word[0].upper()+word[1:] if i != 0 else word for i, word in enumerate(text.split())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same thing about the usage of capitalize here

)
converted_text, embed = await self._clean_text(ctx, text, conversion_func)
await ctx.send(content=converted_text, embed=embed)

@commands.command(name="screamingsnakecase", aliases=("screamsnake", "ssnake", "screamingsnake",))
async def screamingsnakecase_command(self, ctx: Context, *, text: str | None) -> None:
"""Attempts to convert the provided string to SCREAMING_SNAKE_CASE."""
shtlrs marked this conversation as resolved.
Show resolved Hide resolved
text = helpers.neutralise_string(text)
def conversion_func(text: str) -> str:
"""Converts the provided string to SCREAMING_SNAKE_CASE."""
return "_".join(
word.upper() for word in text.split()
)
converted_text, embed = await self._clean_text(ctx, text, conversion_func)
await ctx.send(content=converted_text, embed=embed)

@commands.command(name="camelcase", aliases=("ccase", "camel",))
async def camelcase_command(self, ctx: Context, *, text: str | None) -> None:
"""Attempts to convert the provided string to CamelCase."""
text = helpers.neutralise_string(text)
def conversion_func(text: str) -> str:
"""Converts the provided string to CamelCase."""
return "".join(
word[0].upper()+word[1:] for word in text.split()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a native way of doing this

Suggested change
word[0].upper()+word[1:] for word in text.split()
word.capitalize() for word in text.split()

)
converted_text, embed = await self._clean_text(ctx, text, conversion_func)
await ctx.send(content=converted_text, embed=embed)

@commands.group(name="caesarcipher", aliases=("caesar", "cc",))
Expand Down
27 changes: 27 additions & 0 deletions bot/utils/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,30 @@ def suppress_links(message: str) -> str:
for link in set(re.findall(r"https?://[^\s]+", message, re.IGNORECASE)):
message = message.replace(link, f"<{link}>")
return message

def neutralise_string(txt: str | None) -> str | None:
"""Attempts to neutralise all punctuation and cases and returns a string of lowercase words."""
# return early if no text provided.
if not txt:
return None

# take out punctuation
shtlrs marked this conversation as resolved.
Show resolved Hide resolved
txt = re.sub(r"([^\w\s]|_)", " ", txt)

# full caps words but leaves CamelCase / pascalCase
words = [word.lower() if word.isupper() else word for word in txt.split()]
txt = " ".join(words)

# attempt to split pascalCase and CamelCase
words = []
old_i = 0
for i, char in enumerate(txt):
# to avoid CamelCase getting leading empty append
if char.isupper() and i != 0:
words.append(txt[old_i:i])
old_i = i
words.append(txt[old_i:])

# strip white spaces and make lowercase
words = [word.strip().lower() for word in words]
return " ".join(words)
Loading