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(SmilesDrawer): add SmilesDrawer component #5073

Merged
merged 7 commits into from
Jan 9, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 9, 2025

add SmilesDrawer component

Summary of the changes (Less than 80 chars)

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

Description

fixes #5068

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 a SmilesDrawer component to display molecular structures using SMILES strings.

New Features:

  • Introduce a new SmilesDrawer component to render molecules from SMILES notations.

Tests:

  • Include sample code and demos for the SmilesDrawer component.

Copy link

sourcery-ai bot commented Jan 9, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new SmilesDrawer component that visually renders molecules from SMILES strings. It includes a sample page with demonstrations of the component and its size customization options.

Class diagram for SmilesDrawer component and options

classDiagram
    class SmilesDrawer {
        +string Smiles
        +SmilesDrawerOptions Options
    }

    class SmilesDrawerOptions {
        +string Theme
        +int Width
        +int Height
    }

    SmilesDrawer --> SmilesDrawerOptions : uses
Loading

File-Level Changes

Change Details Files
Added a new SmilesDrawer component.
  • Created the SmilesDrawer component to render molecules from SMILES strings.
  • Added size customization options for the SmilesDrawer component.
  • Created a sample page to demonstrate the usage of the SmilesDrawer component, including examples with different sizes and themes.
src/BootstrapBlazor.Server/Components/Samples/SmilesDrawers.razor
src/BootstrapBlazor.Server/Components/Samples/SmilesDrawers.razor.cs
Updated project files and localization resources.
  • Added project dependencies for the SmilesDrawer component.
  • Added menu item for the SmilesDrawer component demo page.
  • Updated localization resources for the SmilesDrawer component and its demo page.
  • Updated documentation for the SmilesDrawer component.
src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj
src/BootstrapBlazor.Server/Extensions/MenusLocalizerExtensions.cs
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
src/BootstrapBlazor.Server/docs.json

Assessment against linked issues

Issue Objective Addressed Explanation
#5068 Add SmilesDrawer 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

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 9, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 9, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 9, 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:

  • Please complete the PR template sections, particularly the Risk assessment and Verification details. This helps reviewers better understand the impact of the changes.
  • Consider adding documentation that explains what SmilesDrawer is and its intended use case for developers who may not be familiar with molecular visualization.
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.

Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (28b3d4a) to head (ab37cec).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5073   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27969     27969           
  Branches      4010      4010           
=========================================
  Hits         27969     27969           

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

@ArgoZhang ArgoZhang enabled auto-merge (squash) January 9, 2025 02:30
@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:

  • Please add documentation explaining what SMILES notation is, the supported format/syntax, and example use cases for the SmilesDrawer component. This will help users understand how to effectively use this specialized component.
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 68ddec2 into main Jan 9, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-smiles branch January 9, 2025 02:31
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(SmilesDrawer): add SmilesDrawer component
1 participant