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

fix(BootstrapInputNumber): throw exception when NumberDecimalSeparator is comma #5028

Merged
merged 4 commits into from
Jan 3, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 3, 2025

throw exception when NumberDecimalSeparator is comma

Summary of the changes (Less than 80 chars)

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

Description

fixes #5027

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

Bug Fixes:

  • Fixed an issue where BootstrapInputNumber would not render correctly when the NumberDecimalSeparator was set to a comma.

@bb-auto bb-auto bot added the bug Something isn't working label Jan 3, 2025
Copy link

sourcery-ai bot commented Jan 3, 2025

Reviewer's Guide by Sourcery

This pull request fixes a bug in the BootstrapInputNumber component where it would not throw an exception when the NumberDecimalSeparator is a comma. The fix changes the IsNumber method to IsNumberWithDotSeparator and updates the culture info used to determine the decimal separator.

Sequence diagram for number input validation flow

sequenceDiagram
    participant C as Component
    participant U as Utility
    participant E as ObjectExtensions
    participant CI as CultureInfo

    C->>U: Generate Component Type
    U->>E: IsNumberWithDotSeparator(fieldType)
    E->>CI: Get CurrentUICulture.NumberFormat
    CI-->>E: Return NumberDecimalSeparator
    alt separator is not "."
        E-->>U: Return false
    else separator is "."
        E->>E: IsNumber()
        E-->>U: Return number type check result
    end
    U-->>C: Return appropriate component type
Loading

Class diagram showing updated ObjectExtensions methods

classDiagram
    class ObjectExtensions {
        +IsNumber(Type t) bool
        +IsNumberWithDotSeparator(Type t) bool
    }
    note for ObjectExtensions "IsNumber now only checks type
IsNumberWithDotSeparator handles decimal separator validation"
Loading

State diagram for number input validation

stateDiagram-v2
    [*] --> CheckDecimalSeparator
    CheckDecimalSeparator --> NotSupported: Separator is comma
    CheckDecimalSeparator --> ValidateType: Separator is dot
    ValidateType --> IsNumber: Valid numeric type
    ValidateType --> NotNumber: Invalid type
    IsNumber --> [*]
    NotNumber --> [*]
    NotSupported --> [*]
Loading

File-Level Changes

Change Details Files
Updated the logic to check NumberDecimalSeparator
  • Changed the IsNumber method to IsNumberWithDotSeparator to check that the separator is a dot.
  • Updated the culture info used to determine the decimal separator from CultureInfo.CurrentCulture to CultureInfo.CurrentUICulture.
  • Updated the GenerateComponentType and CreateMultipleAttributes methods to use the new IsNumberWithDotSeparator method.
  • Added unit tests to verify the new behavior and ensure that existing functionality is not affected.
src/BootstrapBlazor/Extensions/ObjectExtensions.cs
test/UnitTest/Extensions/ObjectExtensionsTest.cs
src/BootstrapBlazor/Utils/Utility.cs
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5027 Fix the issue with int32 type binding failing in Spanish language settings
#5027 Ensure BootstrapInputNumberBase works correctly across different culture settings

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 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

@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:

  • This appears to be a breaking change for users in regions using comma as decimal separator. Please update the documentation to clearly describe this limitation and its impact.
  • Consider adding a more informative error message or exception when the component cannot be used due to incompatible decimal separator settings, rather than silently returning false.
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 ArgoZhang enabled auto-merge (squash) January 3, 2025 04:27
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 (47d2463) to head (4928bf7).
Report is 1 commits behind head on main.

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

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

@ArgoZhang
Copy link
Collaborator Author

@sourcery-ai review

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 XML documentation to IsNumberWithDotSeparator() explaining why only dot decimal separators are supported.
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 ArgoZhang merged commit 91f0e77 into main Jan 3, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-input branch January 3, 2025 04:42
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(InputNumber): 西班牙语言导致绑定int32提示转换失败
1 participant