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

fix: choose joke type per language support #41

Merged
merged 2 commits into from
Dec 1, 2024
Merged

fix: choose joke type per language support #41

merged 2 commits into from
Dec 1, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Dec 1, 2024

feat: add portuguese puns + Pun keyword

Summary by CodeRabbit

  • New Features

    • Added a "Puntuguese dataset" reference in the "Credits" section of the README, enhancing humor content diversity.
    • Improved joke selection logic based on language and category in the JokingSkill feature.
    • Introduced new vocabulary files for English and Portuguese, including terms related to humor and wordplay.
  • Bug Fixes

    • Enhanced responsiveness of joke handling to user preferences.
  • Documentation

    • Updated README to acknowledge additional resources for joke content.

feat: add portuguese puns + Pun keyword
Copy link

coderabbitai bot commented Dec 1, 2024

Walkthrough

The changes in this pull request include the addition of a new entry in the "Credits" section of the README.md file, acknowledging the "Puntuguese dataset" for its contribution to humor resources. Modifications were made to the JokingSkill class in __init__.py, enhancing joke selection logic based on language and joke category. New vocabulary files Pun.voc were created for both English (US) and Portuguese, introducing terms related to puns and wordplay. Additionally, the translations/en-us/vocabs.json file was updated to include the new vocabulary entries.

Changes

File Change Summary
README.md Added entry to "Credits": [Puntuguese dataset](https://github.com/Superar/Puntuguese)
init.py Modified handle_joke and handle_search_joke methods in JokingSkill class for joke selection
locale/en-us/Pun.voc Added new vocabulary entries: pun, Wordplay, quip
locale/pt-pt/Pun.voc Added new vocabulary entries: "Duplo sentido", "trocadilho", "Jogo de palavras"
translations/en-us/vocabs.json Added new vocabulary entry for "Pun.voc": ["pun", "Wordplay", "quip"]

Poem

In the meadow where laughter blooms,
New puns and quips chase away the glooms.
With words that play and twist with glee,
Our jokes now dance in harmony! 🐇✨
Thanks to datasets and vocab so bright,
We share our humor, spreading delight!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the fix label Dec 1, 2024
@github-actions github-actions bot added fix and removed fix labels Dec 1, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)
translations/en-us/vocabs.json (1)

9-13: Maintain consistent capitalization in vocabulary terms

The capitalization is inconsistent among the terms. Consider standardizing to either all lowercase or title case.

     "Pun.voc": [
-        "pun",
-        "Wordplay",
-        "quip"
+        "Pun",
+        "Wordplay",
+        "Quip"
     ],
README.md (1)

35-35: Maintain consistent list style in Credits section

The new entry uses a dash (-) while other entries use asterisks (*). Let's maintain consistency with the existing style.

-  - [Puntuguese dataset](https://github.com/Superar/Puntuguese) (portuguese puns)
+  * [Puntuguese dataset](https://github.com/Superar/Puntuguese) (portuguese puns)
🧰 Tools
🪛 Markdownlint (0.35.0)

35-35: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

__init__.py (1)

38-46: Consider implementing TODO items and improving category handling

The code has two TODO items that should be addressed:

  1. Adding more joke types
  2. Implementing category blacklisting

Additionally, the category handling could be more maintainable.

Consider these improvements:

  1. Move category validation to a configuration:
class JokingSkill(OVOSSkill):
    CATEGORY_DIALOG_MAP = {
        "chuck_norris": "chuck_norris_jokes",
        "dad": "dad_jokes",
        "programmer": "dev_jokes",
        "pun": "puns"
    }
    
    def handle_search_joke(self, message: Message) -> None:
        category = message.data["search"].lower()
        self.log.debug("joke search: %s", category)
        
        for cat_name, dialog_name in self.CATEGORY_DIALOG_MAP.items():
            if self.voc_match(voc_filename=cat_name, utt=category, lang=self.lang):
                self.speak_dialog(dialog_name)
                return
        
        self.speak_dialog("no_joke", {"search": category})
  1. Add category blacklisting support:
    @property
    def blacklisted_categories(self):
        return self.settings.get("blacklisted_categories", ["adult", "nsfw"])
        
    def handle_search_joke(self, message: Message) -> None:
        category = message.data["search"].lower()
        if category in self.blacklisted_categories:
            self.speak_dialog("inappropriate_category")
            return
        # ... rest of the method

Would you like me to create GitHub issues to track these improvements?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9a5e54a and 8231540.

📒 Files selected for processing (5)
  • README.md (1 hunks)
  • __init__.py (1 hunks)
  • locale/en-us/Pun.voc (1 hunks)
  • locale/pt-pt/Pun.voc (1 hunks)
  • translations/en-us/vocabs.json (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • locale/en-us/Pun.voc
  • locale/pt-pt/Pun.voc
🧰 Additional context used
🪛 Markdownlint (0.35.0)
README.md

35-35: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

__init__.py Show resolved Hide resolved
@JarbasAl JarbasAl merged commit 4a219fa into dev Dec 1, 2024
1 check passed
@JarbasAl JarbasAl deleted the pt branch December 1, 2024 18:05
@coderabbitai coderabbitai bot mentioned this pull request Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant