Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 3, 2025

add nullable mark for Formatter parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5029

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

Update the Formatter parameter of the ITableColumn interface to accept nullable objects.

Bug Fixes:

Enhancements:

  • Improve type handling of numeric inputs to support nullable values.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 3, 2025

Reviewer's Guide by Sourcery

This pull request refactors the Formatter parameter of the ITableColumn interface and related components by adding a nullable mark. This change allows the Formatter parameter to accept null values, providing more flexibility in handling column formatting. The IsNumber method is updated to check for number types regardless of culture settings. A new method IsNumberWithDotSeparator is introduced to specifically check for number types with a dot decimal separator. The logic in Utility.cs and ObjectExtensions.cs is updated to use IsNumberWithDotSeparator to ensure correct rendering of number types in different cultures.

Class diagram showing number type checking methods

classDiagram
    class ObjectExtensions {
        +IsNumber(Type t) bool
        +IsNumberWithDotSeparator(Type t) bool
    }

    note for ObjectExtensions "IsNumber: Check numeric types regardless of culture
IsNumberWithDotSeparator: Check numeric types with dot separator"
Loading

File-Level Changes

Change Details Files
Add nullable mark to Formatter parameter
  • Changed the type of the Formatter parameter from Func<object, Task<string?>> to Func<object?, Task<string?>>.
src/BootstrapBlazor/Attributes/AutoGenerateColumnAttribute.cs
src/BootstrapBlazor/Components/Table/ITableColumn.cs
src/BootstrapBlazor/Components/Table/InternalTableColumn.cs
src/BootstrapBlazor/Components/Table/TableColumn.cs
Introduce IsNumberWithDotSeparator method
  • Added a new method IsNumberWithDotSeparator to check for number types with a dot decimal separator.
  • Updated the IsNumber method to check for number types regardless of culture settings.
  • Updated the logic in Utility.cs and ObjectExtensionsTest.cs to use IsNumberWithDotSeparator.
src/BootstrapBlazor/Extensions/ObjectExtensions.cs
src/BootstrapBlazor/Utils/Utility.cs
test/UnitTest/Extensions/ObjectExtensionsTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5029 Add nullable mark for Formatter parameter

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 enhancement New feature or request label Jan 3, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 3, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 3, 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 using either CurrentCulture or CurrentUICulture consistently across IsNumber() and IsNumberWithDotSeparator() methods to avoid potential culture-related issues
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.

# Conflicts:
#	test/UnitTest/Extensions/ObjectExtensionsTest.cs
@codecov
Copy link

codecov bot commented Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (91f0e77) to head (ef364ea).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5030   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27961     27961           
  Branches      4007      4007           
=========================================
  Hits         27961     27961           

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

@ArgoZhang ArgoZhang merged commit 907f9c0 into main Jan 3, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-export branch January 3, 2025 04:52
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.

refactor(ITableColumn): add nullable mark for Formatter parameter

2 participants