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(TableColumn): remove Formatter on TableColumn #4892

Merged
merged 20 commits into from
Dec 19, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 19, 2024

remove Formatter on TableColumn

Summary of the changes (Less than 80 chars)

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

Description

fixes #4887

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

Enhancements:

  • Remove the Formatter delegate from TableColumn, simplifying the rendering logic.

Copy link

sourcery-ai bot commented Dec 19, 2024

Reviewer's Guide by Sourcery

This PR removes the Formatter functionality from TableColumn component and replaces it with FormatString where needed. The implementation focuses on simplifying the column value rendering logic by eliminating the async formatter callback delegate and relying on the FormatString property instead.

Sequence diagram for TableColumn rendering process

sequenceDiagram
    participant User
    participant TableColumn
    participant Utility
    User->>TableColumn: Request to render value
    TableColumn->>Utility: Format value using FormatString
    Utility-->>TableColumn: Formatted value
    TableColumn-->>User: Rendered value
    note over TableColumn: Formatter callback removed
Loading

Class diagram for TableColumn changes

classDiagram
    class TableColumn {
        - Formatter
        + FormatString
    }
    class TableColumnContext {
        - Value
    }
    TableColumn --> TableColumnContext : uses
    note for TableColumn "Formatter removed, FormatString used instead"
Loading

File-Level Changes

Change Details Files
Remove Formatter functionality from TableColumn component
  • Remove IntFormatter method that was used for custom number formatting
  • Remove Formatter delegate handling from RenderValue method
  • Simplify value rendering logic to only use FormatString
src/BootstrapBlazor.Server/Components/Samples/Table/TablesColumn.razor.cs
src/BootstrapBlazor/Extensions/ITableColumnExtensions.cs
Update table column definitions in demo components
  • Replace Formatter attribute with FormatString for number formatting
  • Update Count column to use '0.00' format string instead of custom formatter
src/BootstrapBlazor.Server/Components/Samples/Table/TablesColumn.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#4887 Fix the async Formatter functionality in TableColumn

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 bug Something isn't working label Dec 19, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 19, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 19, 2024
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:

  • Please update the documentation to reflect the removal of the Formatter property from TableColumn, as this is a breaking change that affects the public API.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 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
Copy link
Collaborator Author

@codecov-ai-reviewer review

Copy link

codecov bot commented Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7de5f7e) to head (6db218d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4892   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          623       624    +1     
  Lines        27846     27863   +17     
  Branches      3993      4002    +9     
=========================================
+ Hits         27846     27863   +17     

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

@ArgoZhang ArgoZhang merged commit f11bd8e into main Dec 19, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-format branch December 19, 2024 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug(TableColumn): async Formatter not work
1 participant