Skip to content

feat(ImageCorpper): update AspectRatio type to float#456

Merged
ArgoZhang merged 2 commits intomasterfrom
feat-corp
Jun 6, 2025
Merged

feat(ImageCorpper): update AspectRatio type to float#456
ArgoZhang merged 2 commits intomasterfrom
feat-corp

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Jun 6, 2025

Link issues

fixes #455

Summary By Copilot

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

Update the ImageCropper component to support fractional aspect ratios

Bug Fixes:

Enhancements:

  • Change ImageCropperOption.AspectRatio from int? to float? to allow non-integer values

@bb-auto bb-auto Bot added the enhancement New feature or request label Jun 6, 2025
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Jun 6, 2025

Reviewer's Guide

Refactored the ImageCropperOption to support floating‐point aspect ratios by changing the AspectRatio property type and updating the project configuration.

File-Level Changes

Change Details Files
Convert AspectRatio property from integer to float to allow non‐integer ratios
  • Changed AspectRatio type from int? to float?
  • Kept JSON serialization settings intact for null values
src/components/BootstrapBlazor.ImageCropper/ImageCropperOption.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#455 Update the AspectRatio type in the ImageCropperOption class to float.

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!

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 this to the v9.2.0 milestone Jun 6, 2025
@ArgoZhang ArgoZhang merged commit 6db0fe5 into master Jun 6, 2025
1 check passed
@ArgoZhang ArgoZhang deleted the feat-corp branch June 6, 2025 08:21
Copy link
Copy Markdown

@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:

  • This change to a float API is breaking; please document it in your changelog and bump the package version accordingly.
  • Verify that the underlying JS cropper initialization and IJSRuntime interop support fractional aspect ratios and update the JS code if needed.
  • Consider adding a small integration test or sample demonstrating a non‐integer aspect ratio to ensure the new behavior works as expected.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues 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.

Comment on lines 37 to +38
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? AspectRatio { get; set; }
public float? AspectRatio { get; set; }
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (bug_risk): Validate that AspectRatio is positive and non-zero

Enforce AspectRatio > 0 in the setter or validate it in OnParametersSet to prevent undefined behavior.

Suggested change
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? AspectRatio { get; set; }
public float? AspectRatio { get; set; }
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
private float? _aspectRatio;
public float? AspectRatio
{
get => _aspectRatio;
set
{
if (value.HasValue && value.Value <= 0)
{
throw new ArgumentOutOfRangeException(nameof(AspectRatio), "AspectRatio must be positive and non-zero.");
}
_aspectRatio = value;
}
}

@@ -35,7 +35,7 @@ public class ImageCropperOption
/// </summary>
/// <remarks>默认情况下,裁剪框具有自由比例。 设置为1, 裁剪区默认正方形</remarks>
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: Update remarks to mention fractional aspect ratios

Please update the XML documentation to specify that floating-point aspect ratios (e.g., 1.5) are now supported.

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(ImageCorpper): update AspectRatio type to float

1 participant