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.

Sign up for GitHub

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

Jump to bottom

Fix MemoryStream.CanWrite to allow read-only #67

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix MemoryStream.CanWrite to allow read-only #67

wants to merge 3 commits into from

Conversation

mizady
Copy link

@mizady mizady commented Dec 23, 2024 •
edited
Loading

Description

  • Add _isWritable backing CanWrite so that stream can be made read only via another constructor that specifies whether the stream is writable.
  • Add Test for new constructor in CanWrite tests.
  • Corrected constructor xml documentation that incorrectly stated that the MemoryStream allowed set length when buffer was provided.

Motivation and Context

How Has This Been Tested?

This has been tested by adding a test to verify that the constructor creates the MemoryStream correctly. This should not affect existing code, and existing tests continue to pass uneffected by changes.

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
  • I have added new tests to cover my changes.

@mizady
Fix MemoryStream.CanWrite to allow read-only
1468a3b 
Add _isWritable backing CanWrite so that stream can be made read only via another constructor that specifies whether the stream is writable.

Add Test for new constructor in CanWrite tests
@nfbot nfbot added Type: bug Something isn't working Type: enhancement New feature or request Type: Unit Tests Type: Documentation Improvements or additions to documentation labels Dec 23, 2024
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Dec 23, 2024

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (2)
  • System.IO.Streams/MemoryStream.cs is excluded by none and included by none
  • UnitTests/MemoryStreamUnitTests/CanWrite.cs is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

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

Ellerbach
Ellerbach reviewed Dec 24, 2024
View reviewed changes
Copy link
Member

@Ellerbach Ellerbach left a comment

Choose a reason for hiding this comment

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

Thanks, all up, looks good, couple of comments to simplify a bit

System.IO.Streams/MemoryStream.cs Show resolved Hide resolved
System.IO.Streams/MemoryStream.cs Outdated Show resolved Hide resolved
UnitTests/MemoryStreamUnitTests/CanWrite.cs Outdated Show resolved Hide resolved
@mizady
Refactored to reduce repetition
911ce0f 
Modified test for new constructor to include both true and false conditions.

Combined constructors to reduce repetition.

Moved CanWrite check to private function to reduce repetition.
Ellerbach
Ellerbach reviewed Dec 26, 2024
View reviewed changes
Copy link
Member

@Ellerbach Ellerbach left a comment

Choose a reason for hiding this comment

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

Almost perfect! Thanks again!

System.IO.Streams/MemoryStream.cs Outdated Show resolved Hide resolved
System.IO.Streams/MemoryStream.cs Show resolved Hide resolved
@mizady
Updated documentation
206062b 
Added explanation to NotSupportException documentation where EnsureWritable is used.

Corrected punctuation typo.
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Ellerbach Ellerbach Ellerbach left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Type: bug Something isn't working Type: Documentation Improvements or additions to documentation Type: enhancement New feature or request Type: Unit Tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Failing Unit Tests in nanoframework.System.Net.Http
3 participants
@mizady @Ellerbach @nfbot