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.

Sign up for GitHub

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

Revert changes done in #216 #238

Merged
merged 3 commits into from
Dec 5, 2024
+93 −61
Merged

Revert changes done in #216 #238

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea794e5
Revert changes from 216
dkotter Dec 3, 2024
74f6e48
Add E2E tests for testing the output of wp_get_attachment_image and g…
dkotter Dec 3, 2024
fab05a2
Fix spacing
dkotter Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 16 additions & 37 deletions safe-svg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,9 +444,9 @@ public function fix_admin_preview( $response, $attachment, $meta ) {
*/
public function one_pixel_fix( $image, $attachment_id, $size, $icon ) {
if ( get_post_mime_type( $attachment_id ) === 'image/svg+xml' ) {
$dimensions = $this->get_svg_dimensions( $attachment_id, $size );
$dimensions = $this->svg_dimensions( $attachment_id, $size );

if ( is_array( $dimensions ) && isset( $dimensions['height'], $dimensions['width'] ) ) {
if ( $dimensions ) {
$image[1] = $dimensions['width'];
$image[2] = $dimensions['height'];
} else {
Expand Down Expand Up @@ -499,12 +499,22 @@ public function load_custom_admin_style() {
*/
public function get_image_tag_override( $html, $id, $alt, $title, $align, $size ) {
$mime = get_post_mime_type( $id );

if ( 'image/svg+xml' === $mime ) {
$dimensions = $this->get_svg_dimensions( $id, $size );
if ( is_array( $size ) ) {
$width = $size[0];
$height = $size[1];
} elseif ( 'full' === $size && $dimensions = $this->svg_dimensions( $id ) ) { // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found, Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure
$width = $dimensions['width'];
$height = $dimensions['height'];
} else {
$width = get_option( "{$size}_size_w", false );
$height = get_option( "{$size}_size_h", false );
}

if ( is_array( $dimensions ) && isset( $dimensions['height'], $dimensions['width'] ) ) {
$html = str_replace( 'width="1" ', sprintf( 'width="%s" ', $dimensions['width'] ), $html );
$html = str_replace( 'height="1" ', sprintf( 'height="%s" ', $dimensions['height'] ), $html );
if ( $height && $width ) {
$html = str_replace( 'width="1" ', sprintf( 'width="%s" ', $width ), $html );
$html = str_replace( 'height="1" ', sprintf( 'height="%s" ', $height ), $html );
} else {
$html = str_replace( 'width="1" ', '', $html );
$html = str_replace( 'height="1" ', '', $html );
Expand Down Expand Up @@ -765,37 +775,6 @@ protected function str_ends_with( $haystack, $needle ) {
$len = strlen( $needle );
return 0 === substr_compare( $haystack, $needle, -$len, $len );
}

/**
* Return custom width or height of the SVG image.
*
* @param int $id Image attachment ID.
* @param string|array $size Size of image. Image size or array of width and height values
* (in that order). Default 'thumbnail'.
*
* @return array|bool Width or height of the SVG image, or false if not found.
*/
protected function get_svg_dimensions( $id, $size ) {
$dimensions = $this->svg_dimensions( $id );

if ( is_array( $size ) ) {
$width = $size[0];
$height = $size[1];
} elseif ( 'full' === $size && is_array( $dimensions ) && isset( $dimensions['width'], $dimensions['height'] ) ) {
$width = $dimensions['width'];
$height = $dimensions['height'];
} else {
$width = get_option( "{$size}_size_w", false );
$height = get_option( "{$size}_size_h", false );
}

if ( $dimensions ) {
$dimensions['width'] = $width;
$dimensions['height'] = $height;
}

return $dimensions;
}
}
}

Expand Down
37 changes: 37 additions & 0 deletions tests/cypress/e2e/safe-svg.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,41 @@ describe('Safe SVG Tests', () => {
cy.activatePlugin('safe-svg-cypress-optimizer-test-plugin');
cy.createPost('Hello World');
});

it('Output of wp_get_attachment_image should use full svg dimensions', () => {
// Activate test plugin.
cy.activatePlugin('safe-svg-cypress-test-plugin');

// Visit the home page.
cy.visit('/');

// Verify that the SVG images are displayed with the correct dimensions.
cy.get('#thumbnail-image').should('have.attr', 'width', '256').should('have.attr', 'height', '256');
cy.get('#medium-image').should('have.attr', 'width', '256').should('have.attr', 'height', '256');
cy.get('#large-image').should('have.attr', 'width', '256').should('have.attr', 'height', '256');
cy.get('#full-image').should('have.attr', 'width', '256').should('have.attr', 'height', '256');
cy.get('#custom-image').should('have.attr', 'width', '256').should('have.attr', 'height', '256');

// Deactivate the test plugin.
cy.deactivatePlugin('safe-svg-cypress-test-plugin');
});

it('Output of get_image_tag should use custom dimensions', () => {
// Activate test plugin.
cy.activatePlugin('safe-svg-cypress-test-plugin');

// Visit the home page.
cy.visit('/');

// Verify that the SVG images are displayed with the correct dimensions.
// TODO: these are the sizes returned but seems they are not correct. get_image_tag_override needs to be fixed.
cy.get('.size-thumbnail.wp-image-6').should('have.attr', 'width', '150').should('have.attr', 'height', '150');
cy.get('.size-medium.wp-image-6').should('have.attr', 'width', '300').should('have.attr', 'height', '300');
cy.get('.size-large.wp-image-6').should('have.attr', 'width', '1024').should('have.attr', 'height', '1024');
cy.get('.size-full.wp-image-6').should('have.attr', 'width', '256').should('have.attr', 'height', '256');
cy.get('.size-100x120.wp-image-6').should('have.attr', 'width', '100').should('have.attr', 'height', '100');

// Deactivate the test plugin.
cy.deactivatePlugin('safe-svg-cypress-test-plugin');
});
});
16 changes: 16 additions & 0 deletions tests/cypress/test-plugin/e2e-test-plugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,19 @@ function ( $tags ) {
return $tags;
}
);

add_action(
'wp_body_open',
function () {
echo wp_get_attachment_image( 6, 'thumbnail', false, [ 'id' => 'thumbnail-image' ] );
echo wp_get_attachment_image( 6, 'medium', false, [ 'id' => 'medium-image' ] );
echo wp_get_attachment_image( 6, 'large', false, [ 'id' => 'large-image' ] );
echo wp_get_attachment_image( 6, 'full', false, [ 'id' => 'full-image' ] );
echo wp_get_attachment_image( 6, [ 100, 120 ], false, [ 'id' => 'custom-image' ] );
echo get_image_tag( 6, '', '', '', 'thumbnail' );
echo get_image_tag( 6, '', '', '', 'medium' );
echo get_image_tag( 6, '', '', '', 'large' );
echo get_image_tag( 6, '', '', '', 'full' );
echo get_image_tag( 6, '', '', '', [ 100, 120 ] );
}
);
6 changes: 3 additions & 3 deletions tests/unit/test-safe-svg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ public function test_one_pixel_fix() {
);

// Test SVG Dimensions
$image_sizes = $this->instance->one_pixel_fix( array(), 1, 'full', false );
$image_sizes = $this->instance->one_pixel_fix( array(), 1, 'thumbnail', false );
if ( ! empty( $image_sizes ) ) {
$image_sizes = array_map( 'intval', $image_sizes );
}
Expand Down Expand Up @@ -307,8 +307,8 @@ public function test_one_pixel_fix() {
}
$this->assertSame(
array(
1 => 500,
2 => 500,
1 => 600,
2 => 600,
),
$image_sizes
);
Expand Down
Loading