Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 21, 2025

support Required parameter

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5415

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

Refactored the AutoGenerateColumnAttribute class by removing the Required property and adjusting related interfaces to streamline the configuration of required fields and tooltips.

Bug Fixes:

  • Fixed an issue where the ShowLabelTooltip property was not correctly set to false when a null value was provided.

Enhancements:

  • Removed the Required property from the AutoGenerateColumnAttribute class and moved the IsRequiredWhenAdd and IsRequiredWhenEdit properties to the ITableColumn interface to provide a more flexible and consistent way to define required fields in the system.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 21, 2025

Reviewer's Guide by Sourcery

This pull request modifies the AutoGenerateColumnAttribute to remove the Required property and instead implement the IEditorItem and ITableColumn interfaces directly. It also refactors the GenerateFoo method to use collection expressions and updates unit tests to reflect the changes.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Modified the AutoGenerateColumnAttribute to remove the Required property and instead implement the IEditorItem and ITableColumn interfaces directly for Required, IsRequiredWhenAdd, and IsRequiredWhenEdit properties.
  • Removed the Required property from AutoGenerateColumnAttribute.
  • Implemented IEditorItem interface to provide Required property.
  • Implemented ITableColumn interface to provide IsRequiredWhenAdd and IsRequiredWhenEdit properties.
  • Updated ShowLabelTooltip property setter to use null-coalescing operator for boolean conversion.
src/BootstrapBlazor/Attributes/AutoGenerateColumnAttribute.cs
Updated unit tests for AutoGenerateColumnAttribute to reflect the removal of the Required property and the implementation of interfaces.
  • Removed assertions for Required, IsRequiredWhenAdd, and IsRequiredWhenEdit properties set directly on the attribute.
  • Added assertions for IsRequiredWhenAdd and IsRequiredWhenEdit properties via the ITableColumn interface.
  • Added assertions for the Required property via the IEditorItem interface.
test/UnitTest/Attributes/AutoGenerateClassTest.cs
Refactored the GenerateFoo method to use collection expressions.
  • Replaced ToList() with collection expressions [..].
src/BootstrapBlazor.Server/Data/Foo.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5415 Remove the Required parameter from the AutoGenerateColumnAttribute.

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 Feb 21, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 21, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 21, 2025
Copy link
Contributor

@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 default value to the RequiredErrorMessage property.
  • The explicit interface implementations seem unnecessary; consider removing them.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 2 issues found
  • 🟡 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.

@codecov
Copy link

codecov bot commented Feb 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1a219dc) to head (1f6eb13).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5416   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          644       644           
  Lines        29350     29350           
  Branches      4129      4128    -1     
=========================================
  Hits         29350     29350           

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

@ArgoZhang ArgoZhang changed the title feat(AutoGenerateColumnAttribute): support Required parameter feat(AutoGenerateColumnAttribute): remove Required parameter Feb 21, 2025
@ArgoZhang
Copy link
Member Author

@sourcery-ai review

@ArgoZhang ArgoZhang enabled auto-merge (squash) February 21, 2025 05:35
Copy link
Contributor

@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-nullable Required property to the attribute for simpler usage.
  • The unit tests could be improved by testing the different combinations of null, true, and false for the nullable boolean properties.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟢 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.

@ArgoZhang ArgoZhang disabled auto-merge February 21, 2025 05:42
@ArgoZhang ArgoZhang merged commit 406eb5a into main Feb 21, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-column branch February 21, 2025 05:42
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(AutoGenerateColumnAttribute): remove Required parameter

2 participants