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

refactor: streamline arithmetic traits with macros #99

Merged
merged 1 commit into from
Jan 6, 2025
Merged

Conversation

shuhuiluo
Copy link
Collaborator

@shuhuiluo shuhuiluo commented Jan 6, 2025

Consolidated repetitive implementations of Add, Sub, Mul, and Div into reusable macros for FractionLike, reducing code duplication and improving maintainability. This change ensures uniform functionality across operations and simplifies future updates.

Summary by CodeRabbit

  • Refactor
    • Simplified arithmetic operations for fractions using macro-based implementations
    • Updated trait implementations for addition, subtraction, multiplication, and division
    • Improved code maintainability without changing existing functionality

Consolidated repetitive implementations of `Add`, `Sub`, `Mul`, and `Div` into reusable macros for `FractionLike`, reducing code duplication and improving maintainability. This change ensures uniform functionality across operations and simplifies future updates.
@shuhuiluo shuhuiluo requested a review from malik672 January 6, 2025 08:53
Copy link

coderabbitai bot commented Jan 6, 2025

Walkthrough

The pull request introduces a macro-based approach to implement arithmetic operations for the FractionLike<M> struct in Rust. The changes replace explicit trait implementations with macro definitions that generate implementations for Add, Sub, Mul, and Div traits. This refactoring aims to reduce code redundancy and improve maintainability while preserving the existing arithmetic operation logic for fractions.

Changes

File Change Summary
src/entities/fractions/fraction.rs - Removed explicit trait implementations for Add, Sub, Mul, and Div
- Added macro definitions impl_add_sub, impl_mul, and impl_div
- Generated trait implementations for owned and borrowed FractionLike<M> instances

Poem

🐰 Macros dance, traits align,
Fractions leap with code so fine!
Redundancy fades, clarity grows,
A rabbit's code elegantly flows!
Arithmetic magic, concise and bright 🧮


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

🧹 Nitpick comments (2)
src/entities/fractions/fraction.rs (2)

228-250: Macro usage for addition and subtraction is concise and effective.

By using macros, you eliminate repetitive code and ensure uniform behavior for both owned and borrowed types. Good job on implementing DRY principles here!

You might consider documenting the macro more thoroughly (e.g., how it handles denominators that are equal vs. not equal) so that future maintainers understand the generated code paths clearly.


253-257: Potential consideration for fraction normalization.

While these macros correctly sum or subtract fractions, the resulting fraction is not normalized (e.g., gcd-based reduction). This is typically fine unless there's a long chain of fractional operations. Consider optional fraction reduction to avoid ballooning numerators or denominators.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3e84e19 and 402d8e5.

📒 Files selected for processing (1)
  • src/entities/fractions/fraction.rs (1 hunks)
🔇 Additional comments (3)
src/entities/fractions/fraction.rs (3)

258-272: Macro-based multiplication logic appears straightforward.

The multiplication approach is correct: multiply numerators and denominators and keep the same metadata. It's consistent with the code style you’ve established.


275-277: Check for tests with borrowed vs. owned operands.

You have macros for both Mul<Self> and Mul<&Self>, but the current tests don't appear to explicitly cover the borrowed version. It might be worth ensuring you have direct tests or confirm that coverage is adequately provided via the existing test suite.


278-292: Division implementation is consistent with fraction logic.

The macro-based approach for division is also clean and mirrors your existing fraction logic. Good job maintaining consistency across arithmetic macros.

src/entities/fractions/fraction.rs Show resolved Hide resolved
@shuhuiluo shuhuiluo merged commit 28cdb67 into master Jan 6, 2025
3 checks passed
@shuhuiluo shuhuiluo deleted the arth branch January 6, 2025 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants