Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 23, 2025

compatible enum value as Items

Summary of the changes (Less than 80 chars)

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

Description

fixes #5431

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

This pull request enhances the Select component to be compatible with enum values used as Items. It also refactors the search functionality to use a more concise syntax.

Bug Fixes:

  • Fixes an issue where the Select component was not compatible with enum values used as Items.

Enhancements:

  • Improves the Select component to correctly handle enum values, allowing them to be used as Items.
  • Refactors the search functionality to use a more concise syntax for creating a new list from the search results.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 23, 2025

Reviewer's Guide by Sourcery

The Select component now correctly handles enum values, allowing them to be used directly as items. Additionally, the TryConvertTo method in ObjectExtensions has been updated.

Sequence diagram for Select component with enum values

sequenceDiagram
    participant SelectComponent
    participant Rows

    SelectComponent->>SelectComponent: GetSelectedRow()
    SelectComponent->>SelectComponent: GetItemWidthEnumValue()
    alt ValueType.IsEnum is true
        SelectComponent->>Rows: Find(i => i.Value == Convert.ToInt32(Value).ToString())
        Rows-->>SelectComponent: SelectedItem or null
    else ValueType.IsEnum is false
        SelectComponent-->>SelectComponent: null
    end
    alt SelectedItem found via enum value
        SelectComponent-->>SelectComponent: Return SelectedItem
    else SelectedItem not found via enum value
        SelectComponent->>SelectComponent: Rows.Find(i => i.Value == CurrentValueAsString)
        Rows-->>SelectComponent: SelectedItem or null
        alt SelectedItem found via CurrentValueAsString
            SelectComponent-->>SelectComponent: Return SelectedItem
        else SelectedItem not found via CurrentValueAsString
            SelectComponent->>SelectComponent: Rows.Find(i => i.Active)
            Rows-->>SelectComponent: SelectedItem or null
            alt SelectedItem found via Active
                SelectComponent-->>SelectComponent: Return SelectedItem
            else SelectedItem not found via Active
                SelectComponent->>SelectComponent: Rows.FirstOrDefault(i => !i.IsDisabled)
                Rows-->>SelectComponent: SelectedItem or null
                alt SelectedItem found via IsDisabled
                    SelectComponent-->>SelectComponent: Return SelectedItem
                else SelectedItem not found via IsDisabled
                    SelectComponent->>SelectComponent: GetVirtualizeItem(CurrentValueAsString)
                    SelectComponent-->>SelectComponent: SelectedItem or null
                    SelectComponent-->>SelectComponent: Return SelectedItem or null
                end
            end
        end
    end
Loading

File-Level Changes

Change Details Files
The Select component now supports enum values directly as items.
  • Added a method GetItemWidthEnumValue to handle enum values.
  • Modified GetSelectedRow to use GetItemWidthEnumValue when the value type is an enum.
  • Updated GetRowsBySearch to use collection literals.
src/BootstrapBlazor/Components/Select/Select.razor.cs
The TryConvertTo method in ObjectExtensions has been updated to remove unnecessary type constraints.
  • Removed the explicit type parameter from the BindConverter.TryConvertTo calls.
src/BootstrapBlazor/Extensions/ObjectExtensions.cs
Updated the project file to reflect changes.
  • The project file BootstrapBlazor.csproj was modified.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5431 The Select component should correctly handle enum values when the Items property is set to a collection where the Value field represents the enum's underlying integer value.
#5431 The Select component should allow modification of the selected item when the value type is an enum and the Items property is used.

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 bug Something isn't working label Feb 23, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 23, 2025
@codecov
Copy link

codecov bot commented Feb 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1e1ed9a) to head (52ad5b8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5434   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          645       645           
  Lines        29351     29355    +4     
  Branches      4130      4131    +1     
=========================================
+ Hits         29351     29355    +4     

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

@ArgoZhang ArgoZhang enabled auto-merge (squash) February 23, 2025 03:27
@ArgoZhang
Copy link
Member Author

@sourcery-ai review

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 unit test to specifically cover the enum value scenario.
  • The null-conditional operator could be removed from GetRowsBySearch since the null check is already performed in the FilterBySearchText method.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 d23c876 into main Feb 23, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the fix-select branch February 23, 2025 03:30
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.

feat(Select): 兼容枚举类型值集合作为 Items

2 participants