Skip to content

Fix Guid.TryParseGuidWithDashes() and Guid constructor with string parameter #240

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

Merged
merged 1 commit into from
Mar 10, 2025

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Mar 7, 2025

Description

  • Rework implementation to deal with recent changes in backing fields.
  • Rename parameters to match TryParse.
  • Update IntelliSense comments to match TryParse.
  • Update IntelliSense comments of constructor from string to include only the accepted formats.
  • Minor code change in the string constructor so it doesn't pass the Guid class as parameter to TryParseGuidWithDashes.
  • Add Obsolete attribute with note that the method will be renamed to TryParse in a future version.
  • Add unit tests to cover this method.
  • Add more unit tests for constructors and interaction with Empty property.

Motivation and Context

  • Fixes issue with parsing a GUID from string in registry format.
  • IntelliSense comments were mentioning not supported formats as if they were.
  • Pave way to rename TryParseGuidWithDashes to TryParse as there is no good reason to deviate from the full .NET API.
  • Fixes Converting string to Guid is incorrect Home#1608.

How Has This Been Tested?

  • New unit tests added.

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.

cc @sky9mike

Copy link

coderabbitai bot commented Mar 7, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (2)
  • Tests/NFUnitTestSystemLib/UnitTestGuid.cs is excluded by none and included by none
  • nanoFramework.CoreLibrary/System/Guid.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.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

@josesimoes josesimoes self-assigned this Mar 7, 2025
@josesimoes josesimoes marked this pull request as draft March 7, 2025 15:52
- Rework implementation to deal with recent changes in backing fields.
- Rename parameters to match TryParse.
- Update Intellisense comments to match TryParse.
- Update Intellisense comments of constructor from string to include only the accepted formats.
- Minor code change in the string constructor so it doesn't pass the Guid class as parameter to TryParseGuidWithDashes.
- Add Obsolete attribute with note that the method will be renamed to TryParse in a future version.
- Add unit tests to cover this method.
- Add more unit tests for constructors and interaction with Empty property.
@josesimoes josesimoes changed the title Fix Guid TryParseGuidWithDashes Fix Guid.TryParseGuidWithDashes and Guid constructor with string parameter Mar 7, 2025
@josesimoes josesimoes changed the title Fix Guid.TryParseGuidWithDashes and Guid constructor with string parameter Fix Guid.TryParseGuidWithDashes() and Guid constructor with string parameter Mar 7, 2025
Copy link

sonarqubecloud bot commented Mar 7, 2025

@josesimoes josesimoes marked this pull request as ready for review March 10, 2025 09:27
@josesimoes josesimoes merged commit 296050d into nanoframework:main Mar 10, 2025
6 checks passed
@josesimoes josesimoes deleted the fix-guid branch March 10, 2025 09:28
josesimoes added a commit that referenced this pull request Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Converting string to Guid is incorrect
2 participants