search

ktaroabobon / abobon-jr

0 stars 1 forks source link

Add: thesis command #42

Open ktaroabobon opened 4 months ago

ktaroabobon commented 4 months ago

close #32

やったこと

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

この変更は、Discordボットに論文検索機能を追加し、/thesis コマンドを用いてCiNii APIから特定のキーワードに基づいた最新論文を取得できるようにします。また、ボットの応答処理を整理し、複数のコマンドに対応するためのインタラクションハンドリングのリファクタリングも行われました。これにより、ユーザーはDiscord上で簡単に論文情報を検索し、参照できるようになります。

Changes

ファイルパス 変更内容概要
app/internal/controllers/discord.go 新しいthesisコマンドの追加、インタラクションハンドリングのリファクタリング
app/internal/models/cinii.go CiNiiResponse構造体にネストされた構造体定義を追加
app/internal/models/paper.go Paper構造体のフィールドを拡張
app/internal/repositories/cinni.go CiNiiRepository に FetchThesis メソッドを追加
app/internal/repositories/paper.go PaperRepository に FetchRSS メソッドを追加
app/internal/services/abobon_aritcles.go Abobonアーティクルサービスの定義と対応するメソッドの追加
app/internal/services/handle_commands.go DiscordService のインタラクションハンドリングロジックの更新
app/internal/services/ping.go PingService の HandlePingCommand メソッドの追加
app/internal/services/thesis.go ThesisService に HandleThesisCommand メソッド等を追加
app/internal/utils/config.go 環境変数管理のための Config 構造体と関連する関数の追加
app/main.go 設定オブジェクトを使用してDiscordボットトークンを取得するように更新

Sequence Diagram(s)

/thesis コマンドのシーケンス図

sequenceDiagram
    participant User
    participant DiscordBot
    participant CiNiiAPI
    User->>DiscordBot: /thesis keyword
    DiscordBot->>DiscordBot: HandleInteraction()
    DiscordBot->>CiNiiAPI: FetchThesis(keyword)
    CiNiiAPI-->>DiscordBot: CiNiiResponse
    DiscordBot-->>User: Message with paper details

Assessment against linked issues

Objective Addressed Explanation
CiNiiのAPIを使用して最新論文を取得するコマンドの作成 (#32) ✅
キーワードに基づいた論文検索機能の実装 (#32) ✅
Clean Architectureに従ったファイルと関数分け (#32) ✅

Poem

ふわふわウサギがコードを織る、 新しい機能で検索を彩る。 論文を探し、知識を広げ、 Discordに歓喜が溢れる朝。
🐇📚✨

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.