Added StackNavigator#popToFirst extension function

[arkivanov]

As part of #721.

Summary by CodeRabbit

• Refactor

  • Renamed stack manipulation functions for improved clarity and consistency (e.g., drop to pop).

• Tests

  • Introduced new test cases for popping to the first element in a stack-based router.
  • Updated tests to reflect changes in stack manipulation function names and parameters.

[coderabbitai]

Warning

Rate limit exceeded

@arkivanov has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 34 minutes and 38 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 021c529 and 3c203c1.

Walkthrough

The code changes primarily involve renaming functions in StackNavigatorExt.kt from "Drops" to "Pops" for greater semantic clarity. Additionally, new test cases were added in RouterPopToFirstTest.kt to verify popping elements to the first stack position, and existing test cases in RouterPopToTest.kt were updated to reflect the function name changes. These adjustments collectively enhance readability and consistency in stack manipulation operations.

Changes

Files	Change Summary
.../StackNavigatorExt.kt	Renamed stack manipulation functions from "Drops" to "Pops" to better reflect their behavior.
.../RouterPopToFirstTest.kt	Added new test cases for popping elements to the first position in a stack.
.../RouterPopToTest.kt	Modified test cases to use the updated popTo function with an index parameter.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StackNavigator
    note right of StackNavigator: Improved function names
    User->>StackNavigator: popWhile(predicate)
    User->>StackNavigator: popTo(index, onComplete)
    User->>StackNavigator: popToFirst(onComplete)

Loading

Poem

In the realm where stacks align,
Functions pop and names refine,
Clarity we now uphold,
With tests in place, strong and bold.
Celebrate the code's new phase,
Stack by stack, our hats we raise! 🎩🐇

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 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]

Actionable comments posted: 1

Outside diff range and nitpick comments (1)

decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigatorExt.kt (1)

Line range hint 78-87: Refactor duplicate logic in popWhile.

The two popWhile functions share a significant amount of logic. Consider refactoring to reduce duplication, possibly by having one function call the other with a default onComplete parameter.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 42e5e5e and 021c529.

Files selected for processing (3)

• decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigatorExt.kt (4 hunks)
• decompose/src/commonTest/kotlin/com/arkivanov/decompose/router/stack/RouterPopToFirstTest.kt (1 hunks)
• decompose/src/commonTest/kotlin/com/arkivanov/decompose/router/stack/RouterPopToTest.kt (1 hunks)

Files skipped from review due to trivial changes (1)

• decompose/src/commonTest/kotlin/com/arkivanov/decompose/router/stack/RouterPopToFirstTest.kt

Additional comments not posted (1)

decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigatorExt.kt (1)

123-134: Validate the new popToFirst function.

The implementation of popToFirst correctly delegates to popTo(index = 0), which is a clean and efficient way to ensure that only the first configuration remains active. This maintains consistency and leverages existing logic effectively.