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

incorect dimensions with only one of width or height? #260

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

snoyer
Copy link

@snoyer snoyer commented Feb 20, 2025

When parsing an SVG with a viewBox but only one of width or height (without passing dimensions to SVG.parse())
the .width and .heigth of the resulting SVG look incorrect:

<svg viewBox="0 0 4 3" width="40"/> <!-- .width = 40.0 .height = 3.0 -->
<svg viewBox="0 0 4 3" height="30"/> <!-- .width = 4.0 .height = 30.0 -->
<svg viewBox="0 0 4 3" width="4in"/> <!-- .width = 384.0 .height = 3.0 -->
<svg viewBox="0 0 4 3" height="3in"/> <!-- .width = 4.0 .height = 288.0 -->

Shouldn't we be able to use the aspect ratio of the viewbox to deduce the missing dimension?

With this PR we get:

<svg viewBox="0 0 4 3" width="40"/> <!-- .width = 40.0 .height = 30.0 -->
<svg viewBox="0 0 4 3" height="30"/> <!-- .width = 40.0 .height = 30.0 -->
<svg viewBox="0 0 4 3" width="4in"/> <!-- .width = 384.0 .height = 288.0 -->
<svg viewBox="0 0 4 3" height="3in"/> <!-- .width = 384.0 .height = 288.0 -->

Could anyone please confirm:

  1. whether my assumption is correct
  2. how sound the implementation is as I'm not familiar with the intricacies of the parsing/rendering code
Sample code
from io import StringIO
import svgelements


def test(svg_src: str):
    parsed = svgelements.SVG.parse(StringIO(svg_src))
    print(f"{svg_src} <!-- .width = {parsed.width} .height = {parsed.height} -->")


test('<svg viewBox="0 0 4 3" width="40"/>')
test('<svg viewBox="0 0 4 3" height="30"/>')
test('<svg viewBox="0 0 4 3" width="4in"/>')
test('<svg viewBox="0 0 4 3" height="3in"/>')

Summary by Sourcery

Improves SVG parsing by inferring missing dimensions from the viewBox attribute. When an SVG defines a viewBox and either width or height, the missing dimension is calculated based on the viewBox's aspect ratio. Includes new tests to validate the fix.

Bug Fixes:

  • Fixes an issue where the height or width of an SVG was not correctly inferred from the viewBox when only one dimension was specified.

Enhancements:

  • Infers the missing dimension of an SVG from the viewBox aspect ratio when only one of width or height is provided.

Tests:

  • Adds new tests to verify that the width and height of an SVG are correctly inferred from the viewBox when only one dimension is specified.

Copy link

sourcery-ai bot commented Feb 20, 2025

Reviewer's Guide by Sourcery

This pull request addresses an issue where the width and height of an SVG element were not correctly inferred when only one dimension was specified alongside a viewBox. The implementation calculates the missing dimension using the aspect ratio of the viewBox. New test cases have been added to validate the fix.

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

File-Level Changes

Change Details Files
Implemented logic to deduce missing width or height based on the viewBox aspect ratio when only one dimension is specified.
  • Added a condition to check if only one of width or height is present and a viewbox exists.
  • Calculates the missing dimension using the aspect ratio derived from the viewBox.
  • Assigns the calculated dimension to the SVG object.
svgelements/svgelements.py
Added new test cases to verify the correct calculation of missing dimensions based on the viewBox.
  • Created test functions for scenarios where either width or height is missing.
  • Asserts that the calculated width and height match the expected values based on the viewBox aspect ratio.
test/test_viewbox.py

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

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 @snoyer - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The new tests are good, but could you add a test case that uses percentage units for width/height?
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant