add `length()` and `is_empty()` to `Buffer` #1044

rami3l · 2024-09-26T06:12:00Z

As required in the Markdown parser implementation.

coderabbitai · 2024-09-26T06:12:14Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

coveralls · 2024-09-26T06:15:51Z

Pull Request Test Coverage Report for Build 3588

Details

2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.007%) to 82.326%

Totals
Change from base Build 3580:	0.007%
Covered Lines:	4197
Relevant Lines:	5098

💛 - Coveralls

bobzhang · 2024-09-29T05:22:51Z

builtin/buffer.mbt

@@ -72,6 +72,16 @@ fn grow_if_necessary(self : Buffer, required : Int) -> Unit {
  }
 }

+/// Return the given buffer's length in bytes.


this is encoding agnostics? How is it useful

@bobzhang This API mirrors OCaml's Buffer.length which counts in bytes (i.e. chars in OCaml), so it is indeed encoding agnostic. Currently it's feasible via b.to_bytes().length() (example), but .to_bytes() introduces an extra copy.

Although in Cmarkit this API is only used to check whether the buffer is empty (namely length b <> 0), other use cases do exist, notably getting a copy of the underlying Bytes towards its end via Buffer.sub (e.g. sub b 42 (length b - 1 - 42)).

Thus, I think it would still be beneficial to expose the buffer length. Of course, I'd be happy to withdraw the .length() API if you consider this to be unnecessary.

we are moving buffer outside builtin to provide a dedicated buffer package mimicking ocaml's behavior cc @hackwaly

hackwaly · 2024-10-11T08:07:04Z

related #1084

bobzhang · 2024-10-12T06:39:59Z

@rami3l can you cherry pick these APIs into the new buffer package

peter-jerry-ye-code-review · 2024-10-12T07:13:10Z

From the provided git diff output, I observe the following potential issues or suggestions for improvement in the MoonBit code:

Potential Bug in length Function:
- The length function returns the length of the buffer in bytes (self.len). However, the comment states that it returns the buffer's length in bytes, which is redundant. It would be helpful to clarify if this is indeed the intended behavior or if there is a misunderstanding in the comment.
```
/// Return the given buffer's length in bytes.
pub fn length(self : Buffer) -> Int {
  self.len
}
```
Potential Redundancy in is_empty Function:
- The is_empty function checks if the buffer length is zero (self.len == 0). The comment suggests that it returns whether the buffer is empty, which aligns with the code. However, the comment could be more concise for clarity.
```
/// Return whether the given buffer is empty.
pub fn is_empty(self : Buffer) -> Bool {
  self.len == 0
}
```

Potential Typo in Test Comments:

In the test comments for the length method and is_empty method, the word "method" is repeated. This might be a small typo but can be corrected for better readability.

test "length method" {
  let buf = @buffer.new(size_hint=100)
  inspect!(buf.length(), content="0")
  buf.write_string("Test")
  inspect!(buf.length(), content="8")
}

test "is_empty method" {
  let buf = @buffer.new(size_hint=100)
  inspect!(buf.is_empty(), content="true")
  buf.write_string("Test")
  inspect!(buf.is_empty(), content="false")
}

These observations are based on the provided git diff output and the context provided in the MoonBit language reference.

rami3l · 2024-10-12T07:13:10Z

@rami3l can you cherry pick these APIs into the new buffer package

@bobzhang Rebased.

rami3l · 2024-10-16T09:24:43Z

May I ask what is blocking this PR from being merged? Many thanks in advance :)

bobzhang reviewed Sep 29, 2024

View reviewed changes

rami3l force-pushed the feat/buffer-len branch from 661a8cf to e661942 Compare October 12, 2024 07:12

add length() and is_empty() to Buffer

1326d2e

rami3l force-pushed the feat/buffer-len branch from 721403b to 1326d2e Compare October 16, 2024 09:26

hackwaly requested a review from bobzhang October 17, 2024 16:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add `length()` and `is_empty()` to `Buffer` #1044

add `length()` and `is_empty()` to `Buffer` #1044

rami3l commented Sep 26, 2024

coderabbitai bot commented Sep 26, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coveralls commented Sep 26, 2024 •

edited

Loading

bobzhang Sep 29, 2024

rami3l Sep 29, 2024 •

edited

Loading

bobzhang Oct 10, 2024

hackwaly commented Oct 11, 2024

bobzhang commented Oct 12, 2024

peter-jerry-ye-code-review bot commented Oct 12, 2024 •

edited

Loading

rami3l commented Oct 12, 2024 •

edited

Loading

rami3l commented Oct 16, 2024

add length() and is_empty() to Buffer #1044

Are you sure you want to change the base?

add length() and is_empty() to Buffer #1044

Conversation

rami3l commented Sep 26, 2024

coderabbitai bot commented Sep 26, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coveralls commented Sep 26, 2024 • edited Loading

Pull Request Test Coverage Report for Build 3588

Details

💛 - Coveralls

bobzhang Sep 29, 2024

Choose a reason for hiding this comment

rami3l Sep 29, 2024 • edited Loading

Choose a reason for hiding this comment

bobzhang Oct 10, 2024

Choose a reason for hiding this comment

hackwaly commented Oct 11, 2024

bobzhang commented Oct 12, 2024

peter-jerry-ye-code-review bot commented Oct 12, 2024 • edited Loading

rami3l commented Oct 12, 2024 • edited Loading

rami3l commented Oct 16, 2024

add `length()` and `is_empty()` to `Buffer` #1044

add `length()` and `is_empty()` to `Buffer` #1044

CodeRabbit Configuration File (`.coderabbit.yaml`)

coveralls commented Sep 26, 2024 •

edited

Loading

rami3l Sep 29, 2024 •

edited

Loading

peter-jerry-ye-code-review bot commented Oct 12, 2024 •

edited

Loading

rami3l commented Oct 12, 2024 •

edited

Loading