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

feat(utils): Introduce safe append util #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

andnasnd
Copy link

@andnasnd andnasnd commented Jan 16, 2024

Go's native append reuses old slice allocation if it's capacity is sufficient.

For example:

import "fmt"

func main() {
    a := []byte("🐻")
    a = append(a, 'x')
    b := append(a, 'y')
    c := append(a, 'z')
    fmt.Println(string(a))
    fmt.Println(string(b))
    fmt.Println(string(c))
}

Output:

🐻p
🐻pr
🐻pr

Output should be 🐻xy

Summary by CodeRabbit

  • New Features
    • Introduced new methods for appending elements to lists with options for both in-place and non-modifying operations.

Copy link

coderabbitai bot commented Jan 16, 2024

Walkthrough

The recent update introduces two new functions for handling slices in Go: InPlaceAppend for modifying an existing slice and ImmutableAppend for creating a new slice with added elements. Accompanying tests validate the functionality, ensuring that the in-place version doesn't create additional copies and the immutable version maintains the original slice unaltered.

Changes

Files Change Summary
utils/append.go Added InPlaceAppend and ImmutableAppend functions.
utils/append_test.go Added tests for InPlaceAppend and ImmutableAppend functions.

Poem

🐇💻🌟

In the land of code, where the data hops around,
A rabbit devised a way, for slices to abound.
'In-place' or 'new', append with care,
Run the tests, ensure all's fair.
🌱🥕📈

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0bf7199 and 9eb7463.
Files selected for processing (2)
  • utils/append.go (1 hunks)
  • utils/append_test.go (1 hunks)
Additional comments: 4
utils/append.go (2)
  • 28-31: The InPlaceAppend function correctly uses the append function to modify the slice in place.
  • 33-38: The ImmutableAppend function correctly creates a new slice to ensure immutability of the original slice.
utils/append_test.go (2)
  • 46-81: The tests for InPlaceAppend function correctly check the behavior of the function with different data types and ensure that the slice is modified in place as expected.
  • 84-162: The tests for ImmutableAppend function correctly verify the immutability of the original slice and the correctness of the returned slice after appending elements.

@andnasnd andnasnd changed the title feat(utils): Introduce safe util feat(utils): Introduce safe append util Jan 16, 2024
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