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

feat(Clipboard): remove Clipboard component #4541

Merged
merged 5 commits into from
Oct 25, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Oct 25, 2024

remove Clipboard component

Summary of the changes (Less than 80 chars)

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

Description

fixes #4540

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

Remove the Clipboard component and introduce a new ClipboardService class to manage clipboard operations. Update the BootstrapBlazorRoot component to exclude the Clipboard component and add unit tests for the ClipboardService to ensure its functionality.

New Features:

  • Introduce a new ClipboardService class to handle clipboard operations using JavaScript interop.

Enhancements:

  • Remove the Clipboard component from the BootstrapBlazorRoot component.

Tests:

  • Add unit tests for the new ClipboardService to verify clipboard operations such as copy and get text.

@bb-auto bb-auto bot added the enhancement New feature or request label Oct 25, 2024
@bb-auto bb-auto bot added this to the v8.10.0 milestone Oct 25, 2024
Copy link

sourcery-ai bot commented Oct 25, 2024

Reviewer's Guide by Sourcery

This PR removes the Clipboard component and replaces it with a dedicated ClipboardService. The implementation moves clipboard functionality from a component-based approach to a service-based architecture, improving modularity and reusability.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Remove Clipboard component from root component
  • Remove Clipboard component reference from BootstrapBlazorRoot.razor
src/BootstrapBlazor/Components/BaseComponents/BootstrapBlazorRoot.razor
Introduce new ClipboardService implementation
  • Create service class with clipboard operations
  • Implement Get method to retrieve clipboard contents
  • Implement GetText method to get clipboard text
  • Implement Copy method to copy text to clipboard
  • Add JSModule integration for clipboard operations
src/BootstrapBlazor/Services/ClipboardService.cs
Add comprehensive unit tests for ClipboardService
  • Test Copy functionality
  • Test GetText functionality
  • Test Get functionality with various data scenarios
  • Add mock component for testing clipboard operations
test/UnitTest/Services/ClipboardServiceTest.cs
Remove obsolete clipboard-related files
  • Remove old Clipboard component files
  • Remove old test files
src/BootstrapBlazor/Components/Clipboard/ClipboardService.cs
src/BootstrapBlazor/Components/Clipboard/Clipboard.cs
src/BootstrapBlazor/Components/Clipboard/ClipboardOption.cs
test/UnitTest/Services/ClipboardTest.cs
test/UnitTest/Components/ClipboardServiceTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4540 Remove the Clipboard component

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

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Oct 25, 2024
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:

  • Since this is a breaking change removing the Clipboard component, please ensure documentation is updated with migration instructions for users moving from the component-based approach to the new service-based implementation.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟡 Testing: 3 issues found
  • 🟢 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.

src/BootstrapBlazor/Services/ClipboardService.cs Outdated Show resolved Hide resolved
test/UnitTest/Services/ClipboardServiceTest.cs Outdated Show resolved Hide resolved
test/UnitTest/Services/ClipboardServiceTest.cs Outdated Show resolved Hide resolved
# Conflicts:
#	src/BootstrapBlazor/Components/BaseComponents/BootstrapBlazorRoot.razor
Copy link

codecov bot commented Oct 25, 2024

Codecov Report

Attention: Patch coverage is 94.73684% with 1 line in your changes missing coverage. Please review.

Project coverage is 99.99%. Comparing base (b9a5bbd) to head (21feee9).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/BootstrapBlazor/Services/ClipboardService.cs 94.73% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##              main    #4541      +/-   ##
===========================================
- Coverage   100.00%   99.99%   -0.01%     
===========================================
  Files          629      627       -2     
  Lines        27044    27000      -44     
  Branches      3926     3925       -1     
===========================================
- Hits         27044    26999      -45     
- Partials         0        1       +1     

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

@ArgoZhang ArgoZhang merged commit 696292e into main Oct 25, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-clipboard branch October 25, 2024 04:03
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.

feat(Clipboard): remove Clipboard component
1 participant