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(ObjectExtensions): add CreateInstanceWithCascade extension method #5491

Merged
merged 11 commits into from
Mar 2, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 2, 2025

Link issues

fixes #5490

Summary By Copilot

This pull request includes several changes to the BootstrapBlazor project, focusing on version updates, exception handling improvements, and enhancements to the ObjectExtensions class. The most important changes are listed below:

Version Update:

  • Updated the version in src/BootstrapBlazor/BootstrapBlazor.csproj from 9.4.3-beta03 to 9.4.3-beta04.

Exception Handling:

  • Improved exception handling in CreateInstance method in src/BootstrapBlazor/Components/Table/Table.razor.Edit.cs by including the caught exception in the InvalidOperationException.

ObjectExtensions Enhancements:

  • Added a new method CreateInstanceWithCascade<TItem> to create an instance of a type and ensure all class-type properties are initialized in src/BootstrapBlazor/Extensions/ObjectExtensions.cs.
  • Improved the TryConvertTo method by removing the MaybeNullWhen(false) attribute and updating the method to use pattern matching for better readability in src/BootstrapBlazor/Extensions/ObjectExtensions.cs.
  • Updated XML documentation comments for better clarity and consistency in src/BootstrapBlazor/Extensions/ObjectExtensions.cs. [1] [2]

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

New Features:

  • Adds a CreateInstanceWithCascade extension method to create an instance of a type and ensure all class-type properties are initialized.

Copy link

sourcery-ai bot commented Mar 2, 2025

Reviewer's Guide by Sourcery

This pull request introduces the CreateInstanceWithCascade extension method to handle object instantiation with class-type property initialization. It also refactors the TryConvertTo method for improved readability and updates exception handling in the Table component. Additionally, the project version has been updated.

Sequence diagram for CreateInstanceWithCascade

sequenceDiagram
    participant OE as ObjectExtensions
    participant A as Activator
    participant I as Instance

    OE->>A: CreateInstance<TItem>()
    A-->>I: Instance of TItem
    OE->>I: EnsureInitialized()
    loop For each class-type property
        I->>OE: CreateInstance(PropertyType)
        OE->>A: CreateInstance(PropertyType)
        A-->>I: Instance of PropertyType
        I->>I: EnsureInitialized()
    end
    I-->>OE: Initialized Instance
    OE-->>OE: Return instance
Loading

File-Level Changes

Change Details Files
Introduced a new extension method CreateInstanceWithCascade<TItem> to create instances of types, ensuring all class-type properties are initialized.
  • Added CreateInstanceWithCascade<TItem> method to create an instance of a type and initialize all class-type properties.
  • Implemented EnsureInitialized method to recursively initialize class-type properties of an object.
  • Implemented CreateInstance method to create an instance of a type and initialize all class-type properties.
src/BootstrapBlazor/Extensions/ObjectExtensions.cs
src/BootstrapBlazor/Components/Table/Table.razor.Edit.cs
Improved the TryConvertTo method by removing the MaybeNullWhen(false) attribute and updating the method to use pattern matching for better readability.
  • Removed the MaybeNullWhen(false) attribute from the TryConvertTo method.
  • Updated the TryConvertTo method to use pattern matching for better readability.
src/BootstrapBlazor/Extensions/ObjectExtensions.cs
Updated XML documentation comments for better clarity and consistency.
  • Updated XML documentation comments for the TryConvertTo method.
  • Updated XML documentation comments for the CreateInstanceWithCascade method.
src/BootstrapBlazor/Extensions/ObjectExtensions.cs
Improved exception handling in the CreateInstance method within Table.razor.Edit.cs by including the caught exception in the InvalidOperationException.
  • Included the caught exception in the InvalidOperationException when Activator.CreateInstance<TItem>() fails.
src/BootstrapBlazor/Components/Table/Table.razor.Edit.cs
Updated the version in BootstrapBlazor.csproj.
  • Updated the version from 9.4.3-beta03 to 9.4.3-beta04.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5490 Support null default values for navigation properties.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Mar 2, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 2, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Mar 2, 2025
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a non-recursive version of CreateInstance to avoid potential stack overflows.
  • The reflection code in EnsureInitialized could be a performance bottleneck; consider caching the property information.
Here's what I looked at during the review
  • 🟡 General issues: 3 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Mar 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (16eabff) to head (2d9ff66).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5491   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29541     29563   +22     
  Branches      4163      4165    +2     
=========================================
+ Hits         29541     29563   +22     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang
Copy link
Collaborator Author

@sourcery-ai review

@ArgoZhang ArgoZhang merged commit ea40445 into main Mar 2, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the feat-pp branch March 2, 2025 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(Table): supports null default values ​​for navigation properties
1 participant