Skip to content

Add minus function and tests - #16

Open
Feako wants to merge 1 commit into
mainfrom
feature/minus-calculator
Open

Add minus function and tests#16
Feako wants to merge 1 commit into
mainfrom
feature/minus-calculator

Conversation

@Feako

@Feako Feako commented Aug 7, 2025

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • New Features

    • Added a subtraction function to the calculator, allowing users to calculate the difference between two numbers.
  • Tests

    • Introduced a new test to verify the correctness of the subtraction function.

@coderabbitai

coderabbitai Bot commented Aug 7, 2025

Copy link
Copy Markdown

Walkthrough

A new minus method was added to the Calculator class to perform integer subtraction. Correspondingly, a unit test was introduced in the CalculatorTest class to verify the correctness of this new method. No other code or logic was changed.

Changes

Cohort / File(s) Change Summary
Calculator minus method
app/src/main/java/com/coderabbit/app/calculator/Calculator.kt
Added a public minus(a: Int, b: Int): Int method to return the difference between two integers.
Unit test for minus
app/src/test/java/com/coderabbit/app/calculator/CalculatorTest.kt
Added a test method to assert the correctness of the new minus method in Calculator.

Sequence Diagram(s)

sequenceDiagram
    participant Test as CalculatorTest
    participant Calc as Calculator

    Test->>Calc: minus(4, 2)
    Calc-->>Test: 2
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

  • calculator tests #3: Adds a test for the add method in the same test class; related by context as both PRs extend test coverage for arithmetic methods in Calculator.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6281cd9 and f8569dd.

📒 Files selected for processing (2)
  • app/src/main/java/com/coderabbit/app/calculator/Calculator.kt (1 hunks)
  • app/src/test/java/com/coderabbit/app/calculator/CalculatorTest.kt (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/test/**

⚙️ CodeRabbit Configuration File

**/test/**: - test function names should follow naming rules like given (optional) ... when (required) ... then(required)

  • test function should be implemented @customTest annotation

Files:

  • app/src/test/java/com/coderabbit/app/calculator/CalculatorTest.kt
🔇 Additional comments (1)
app/src/main/java/com/coderabbit/app/calculator/Calculator.kt (1)

13-15: LGTM! Clean and correct implementation.

The minus method follows the same pattern as the existing methods in the class and correctly implements integer subtraction.

Comment on lines +91 to +95
@Test
fun `test minus function be correct`() {
val calculator = Calculator()
assertEquals(calculator.minus(4,2) ,2)
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix test to comply with coding guidelines.

The test violates the coding guidelines in two ways:

  1. Uses @Test annotation instead of required @CustomTest
  2. Test name doesn't follow the "given...when...then" naming pattern

Apply this diff to fix the guideline violations:

-    @Test
-    fun `test minus function be correct`() {
+    @CustomTest
+    fun `given two integers when subtracting then returns correct difference`() {
         val calculator = Calculator()
         assertEquals(calculator.minus(4,2) ,2)
     }

Don't forget to add the import for @CustomTest at the top of the file.

🤖 Prompt for AI Agents
In app/src/test/java/com/coderabbit/app/calculator/CalculatorTest.kt around
lines 91 to 95, replace the @Test annotation with @CustomTest and rename the
test function to follow the "given...when...then" naming pattern, for example,
"givenTwoNumbers_whenMinus_thenCorrectResult". Also, add the import statement
for @CustomTest at the top of the file to ensure the annotation is recognized.

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.

1 participant