Skip to content

feat(IEditor): add Cols parameter#5778

Merged
ArgoZhang merged 7 commits intomainfrom
refactor-doc
Apr 3, 2025
Merged

feat(IEditor): add Cols parameter#5778
ArgoZhang merged 7 commits intomainfrom
refactor-doc

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Apr 3, 2025 •
edited by sourcery-ai Bot
Loading

Link issues

fixes #5777

Summary By Copilot

This pull request includes several changes to improve the functionality and maintainability of the BootstrapBlazor components. The main changes include refactoring the DemoTableEditTemplate component, adding a new Cols property to various components, and updating unit tests to reflect these changes.

Refactoring and component improvements:

Addition of Cols property:

Utility and method updates:

Unit test updates:

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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 Cols parameter to various components to improve layout control and flexibility in the BootstrapBlazor library

New Features:

  • Introduced a new Cols property across multiple components to provide more granular control over column layouts

Enhancements:

  • Refactored EditorForm CSS generation to use the new Cols property
  • Improved component flexibility by adding Cols support to multiple interfaces and classes

Tests:

  • Updated unit tests to include and validate the new Cols property across different components

Chores:

  • Moved code-behind logic for DemoTableEditTemplate to a separate partial class
  • Made IsCheckboxList method public in Utility class

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 3, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces a Cols property to several BootstrapBlazor components, enhancing layout control. It also refactors the DemoTableEditTemplate component for better maintainability and includes corresponding unit test updates. Additionally, the IsCheckboxList method in Utility.cs was made public.

Updated class diagram for EditorItem

classDiagram
  class EditorItem {
    Rows: int
    Cols: int
  }
  EditorItem --|> IEditorItem : implements
Loading

Updated class diagram for InternalTableColumn

classDiagram
  class InternalTableColumn {
    Rows: int
    Cols: int
  }
Loading

File-Level Changes

Change Details Files
Refactored the DemoTableEditTemplate component to improve code organization and readability by separating the code-behind logic from the Razor file.
  • Removed code-behind logic from the .razor file.
  • Created a partial class file to house the code-behind logic.
  • Used explicit closing tags in the Razor file.
 src/BootstrapBlazor.Server/Components/Components/DemoTableEditTemplate.razor
src/BootstrapBlazor.Server/Components/Components/DemoTableEditTemplate.razor.cs
Added a Cols property to several components to allow for more flexible column layout control.
  • Added the Cols property to the EditorItem class and IEditorItem interface.
  • Added the Cols property to the TableColumn and InternalTableColumn classes.
  • Updated the GetCssString method in EditorForm to utilize the Cols property.
  • Updated the CopyValue method in ITableColumnExtensions to copy the Cols property.
 src/BootstrapBlazor/Components/EditorForm/EditorForm.razor.cs
src/BootstrapBlazor/Components/EditorForm/EditorItem.cs
src/BootstrapBlazor/Components/EditorForm/IEditorItem.cs
src/BootstrapBlazor/Components/Table/InternalTableColumn.cs
src/BootstrapBlazor/Components/Table/TableColumn.cs
src/BootstrapBlazor/Extensions/ITableColumnExtensions.cs
Updated unit tests to accommodate the addition of the Cols property and ensure continued functionality.
  • Added the Cols property to the EditorItem test.
  • Updated the InternalTableColumn test to include the Cols property.
  • Updated the TableColumn test to include the Cols property.
  • Updated the CopyValue test to include the Cols property.
  • Updated tests to include the new Cols property in AutoGenerateClassTest.
 test/UnitTest/Attributes/AutoGenerateClassTest.cs
test/UnitTest/Components/EditorFormTest.cs
test/UnitTest/Components/InternalTableColumnTest.cs
test/UnitTest/Components/TableTest.cs
test/UnitTest/Extensions/ITableColumnExtensionsTest.cs
Made the IsCheckboxList method public for broader accessibility.
  • Changed the accessibility of the IsCheckboxList method from private to public.
 src/BootstrapBlazor/Utils/Utility.cs
Removed an unnecessary assertion from a unit test.
  • Removed an unnecessary assertion in ThrottleTest.cs.
 test/UnitTest/Services/ThrottleTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5777 Add a Cols parameter to components to control column layout. ✅

Possibly linked issues

  • feat(IEditor): add Cols parameter #5777: The PR fixes the issue by adding a Cols parameter to control column layout in components like EditorForm, EditorItem, TableColumn, etc., and refactoring DemoTableEditTemplate. The Cols parameter addresses the problem of Row and ColSpan not working correctly.
  • feat(IEditor): add Cols parameter #5777: The PR fixes the rendering issue by adding a Cols parameter to control column layout.
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 enhancement New feature or request label Apr 3, 2025
@bb-auto bb-auto Bot added this to the v9.5.0 milestone Apr 3, 2025
@ArgoZhang ArgoZhang merged commit eeb045d into main Apr 3, 2025
2 checks passed
@ArgoZhang ArgoZhang deleted the refactor-doc branch April 3, 2025 04:20
sourcery-ai[bot]
sourcery-ai Bot approved these changes Apr 3, 2025
View reviewed changes
Copy link
Copy Markdown
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 description or example of how the new Cols property is intended to be used.
  • The change to make IsCheckboxList public seems unrelated to the main feature; consider moving it to a separate PR.
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.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c2aee77) to head (6205240).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5778   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          658       658           
  Lines        30033     30033           
  Branches      4243      4243           
=========================================
  Hits         30033     30033

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Development

Successfully merging this pull request may close these issues.

feat(IEditor): add Cols parameter

1 participant

@ArgoZhang