Skip to content

feat(Sort): Sort extension method support IDynamicObject #4726

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Nov 23, 2024
Merged

feat(Sort): Sort extension method support IDynamicObject #4726

merged 3 commits into from
Nov 23, 2024

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Nov 23, 2024 •
edited by sourcery-ai bot
Loading

Sort extension method support IDynamicObject

Summary of the changes (Less than 80 chars)

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

Description

fixes #4647

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

Add support for sorting IDynamicObject instances with a new Sort extension method and introduce corresponding unit tests to ensure functionality.

New Features:

  • Add support for sorting IDynamicObject instances using a new Sort extension method.

Tests:

  • Introduce a new unit test to verify sorting functionality for IDynamicObject instances.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 23, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This PR extends the Sort functionality to support IDynamicObject by implementing a new sorting mechanism that handles dynamic objects through reflection and type casting. The implementation includes special handling for interface types and adds comprehensive unit tests using DataTable as a test case.

Sequence diagram for sorting IDynamicObject

sequenceDiagram
    participant Client
    participant LambdaExtensions
    participant DataTableDynamicContext
    participant IDynamicObject

    Client->>DataTableDynamicContext: Create context with DataTable
    DataTableDynamicContext->>IDynamicObject: GetItems()
    IDynamicObject-->>Client: Return list of dynamic objects
    Client->>LambdaExtensions: Call Sort with propertyName and SortOrder
    LambdaExtensions->>IDynamicObject: Check if type is IDynamicObject
    alt is IDynamicObject
        LambdaExtensions->>LambdaExtensions: CastAndOrder
        LambdaExtensions->>IDynamicObject: Invoke sorting
        IDynamicObject-->>LambdaExtensions: Return sorted items
    else
        LambdaExtensions->>LambdaExtensions: EnumerableOrderBySimple
    end
    LambdaExtensions-->>Client: Return sorted list
Loading

Class diagram for updated LambdaExtensions

classDiagram
    class LambdaExtensions {
        +IEnumerable~TItem~ EnumerableOrderBy~TItem~(IEnumerable~TItem~ query, string propertyName, SortOrder sortOrder)
        +IEnumerable~TItem~ EnumerableOrderBySimple~TItem~()
        +IEnumerable~TItem~ EnumerableOrderByComplex~TItem~()
        +IEnumerable~TItem~? CastAndOrder~TItem~(IEnumerable~TItem~ query, Type propertyType, string propertyName, SortOrder sortOrder)
        +IOrderedQueryable~TItem~ OrderByInternal~TItem, TKey~(IQueryable~TItem~ query, PropertyInfo memberProperty)
        +IOrderedQueryable~TItem~ OrderByDescendingInternal~TItem, TKey~(IQueryable~TItem~ query, PropertyInfo memberProperty)
        +IOrderedQueryable~TItem~ ThenByInternal~TItem, TKey~(IOrderedQueryable~TItem~ query, PropertyInfo memberProperty)
        +IOrderedQueryable~TItem~ ThenByDescendingInternal~TItem, TKey~(IOrderedQueryable~TItem~ query, PropertyInfo memberProperty)
        +Expression~Func~TItem, TKey~~ GetPropertyLambda~TItem, TKey~(PropertyInfo pi)
    }
    note for LambdaExtensions "Added CastAndOrder method for dynamic object sorting"
Loading

File-Level Changes

Change Details Files
Added support for sorting IDynamicObject collections
  • Added type checking for IDynamicObject interface
  • Implemented CastAndOrder method to handle dynamic object sorting
  • Added fallback to existing sort logic for non-dynamic objects
 src/BootstrapBlazor/Extensions/LambdaExtensions.cs
Added comprehensive unit tests for IDynamicObject sorting
  • Created test cases using DataTable as sample data
  • Added assertions for both ascending and descending sort orders
  • Verified sorting behavior with string-type columns
 test/UnitTest/Extensions/LambadaExtensionsTest.cs
Code cleanup and formatting improvements
  • Simplified PropertyInfo type references
  • Improved code readability through consistent formatting
 src/BootstrapBlazor/Extensions/LambdaExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4647 Fix the Sort function to properly sort IEnumerable lists ✅

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 Nov 23, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 23, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) November 23, 2024 11:56
@ArgoZhang ArgoZhang added enhancement New feature or request and removed bug Something isn't working labels Nov 23, 2024
sourcery-ai[bot]
sourcery-ai bot approved these changes Nov 23, 2024
View reviewed changes
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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue 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 Nov 23, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d0c4d9a) to head (028e222).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #4726   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27368     27395   +27     
  Branches      3919      3923    +4     
=========================================
+ Hits         27368     27395   +27

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

🚨 Try these New Features:

@ArgoZhang ArgoZhang merged commit 227fa5e into main Nov 23, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-extensions branch November 23, 2024 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ArgoZhang ArgoZhang

Labels

enhancement New feature or request

Projects

None yet

Milestone

v9.0.0

Development

Successfully merging this pull request may close these issues.

feat(IEnumerable<DynamicObject>.Sort): Using Sort function on IEnumerable<DynamicObject> returns unsorted list

2 participants

@ArgoZhang